-
Notifications
You must be signed in to change notification settings - Fork 18
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
Edit Readme (and other documentation) #19
Comments
Move information about code contributions to project Wiki (part of #19). Add link to Wiki in readme.
Should also document project vision, design goals, typical use cases, prm's place, etc. |
I can't - for the life of me - figure this out. I've got experience working on python projects (mostly for CS classes, using pipenv for environment management). It might be a little late, but I'd love to help write up some documentation - but I need setting up. |
Exactly what can't you figure out? What kind of setting up do you need? |
Bump @DannyDannyDanny |
I feel like I'm starting to wrap my head around how prm is supposed to be used. Suggestion: Explain that you might need to add EDITS: mistakes, answering my own questions and formatting. |
Mention $EDITOR in README (based on #19 (comment))
I think the project readme is already getting too long and/or verbose.
It would maybe be best if the readme contained only the minimum needed information (subjects), such as the demo-gif, how to set up prm and get started, etc., so as to not overwhelm new users.
Other information, such as notes on contributions, could go into the wiki.
I would appreciate input about what should go where, be rewritten (and how), and so on.
The text was updated successfully, but these errors were encountered: