-
Notifications
You must be signed in to change notification settings - Fork 14
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
README is getting a bit unwieldy... #173
Comments
I've split README.md into INSTALLATION.md and USAGE.md and made a draft PR at #204. |
Three options:
|
204 merged - README is now slimmed down. |
The Installation instructions aren't good for non-python people. For instance, I had no idea what |
The instructions are intended to be followed as given, even if their meaning isn't fully understood, as explaining them falls outside the project's scope and would make the documentation even more unwieldy. |
The documentation has been sorted out. |
I mentioned in a recent PR review that I think at some point we should move the more detailed instructions out of the main README and into their own separate files.
What I think might work is each major platform having its own INSTALLATION file and there being a single main USAGE file for aspects that are common to all platforms.
At some point down the line it could make sense to put all this in, like, a readthedocs documentation site using Sphinx, but until then having separate Markdown files to read here on GitHub should work fine.
The text was updated successfully, but these errors were encountered: