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.

Sign up for GitHub

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

Jump to bottom

Update the README #200

Open
jakirkham opened this issue Mar 31, 2015 · 1 comment
Open

Update the README #200

jakirkham opened this issue Mar 31, 2015 · 1 comment

Comments

@jakirkham
Copy link
Member

The text in the README could use a little more background on installation. Also, the details of how to use the executables should migrate its way into the documentation. Namely into the module docstring used to solve this ( https://github.com/jakirkham/nanshe/issues/198 ).
@jakirkham
Copy link
Member Author

Honestly, it probably could use a complete rewrite. Installation has changed entirely since it was written. Also, much of the information in the README has moved to the docs. It should be made very succinct.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jakirkham