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

Edit Readme (and other documentation) #19

Open
EivindArvesen opened this issue Sep 25, 2015 · 5 comments
Open

Edit Readme (and other documentation) #19

EivindArvesen opened this issue Sep 25, 2015 · 5 comments

Comments

@EivindArvesen
Copy link
Owner

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.

EivindArvesen added a commit that referenced this issue Sep 27, 2015
Move information about code contributions to project Wiki (part of #19). Add link to Wiki in readme.
@EivindArvesen
Copy link
Owner Author

Should also document project vision, design goals, typical use cases, prm's place, etc.

@EivindArvesen EivindArvesen mentioned this issue Oct 9, 2015
@EivindArvesen EivindArvesen changed the title Documentation Edit Readme (and other documentation) Oct 9, 2015
@EivindArvesen EivindArvesen added this to the 0.0.9 milestone Oct 27, 2015
@DannyDannyDanny
Copy link

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.

@EivindArvesen
Copy link
Owner Author

Exactly what can't you figure out?

What kind of setting up do you need?

@EivindArvesen
Copy link
Owner Author

Bump @DannyDannyDanny

@DannyDannyDanny
Copy link

DannyDannyDanny commented Mar 14, 2019

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.

EivindArvesen added a commit that referenced this issue Mar 17, 2019
Mention $EDITOR in README (based on #19 (comment))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants