Edit Readme (and other documentation)
EivindArvesen opened this issue · 5 comments
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.
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 export EDITOR="/usr/local/bin/nano" to .zshrc or .bashrc
EDITS: mistakes, answering my own questions and formatting.