Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reduce size of README #37

Open
dbeatty10 opened this issue Oct 5, 2022 · 0 comments
Open

Reduce size of README #37

dbeatty10 opened this issue Oct 5, 2022 · 0 comments

Comments

@dbeatty10
Copy link
Collaborator

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant