-
Notifications
You must be signed in to change notification settings - Fork 0
Update documentation
The wiki still needs work. Any and all suggestions/contributions here would be great.
Also, all pages need to be converted to reStructureText standard from markdown.
The renewed work on the user manual is now in progress! Check it out!
It is still quite a ways from complete and could also use more tutorials. You'll need to pip install sphinx and open up the docs directory in the repo to get started on this.
The readme is woefully out of date.
The README.rst file is symlinked to the README.txt file. The Readme.txt file is for Windows users who might not know what to do with an .rst file. The .rst file is so that Github actually renders the markup on the project page like we want it to. The README files are the sc2reader pypi home page so keep that in mind when editing them.