Reduce size of README
dbeatty10 opened this issue · 0 comments
dbeatty10 commented
Currently, the README is a giant wall of text that is intimidating to me.
As a user, I always appreciate the main focus to be install instructions that help me get hands-on. Everything else is a distraction from that goal, in my opinion.
What good looks like
- minimum prerequisites
- minimum software to install
- minimum skills/knowledge required
- the user can quickly find all the commands they need to run
- the relevant commands don't need to be fished out from the middle of sentences (see example below)
- work for the greatest number of users
- instructions that are cross-platform (zsh, PowerShell, etc)
- ideally fits on a single page
Example of fishing out relevant commands
- pip upgrade command needs to be fished out from here
- Should just be a stand-alone line that says this instead:
pip install --upgrade pip