search

makehackvoid / mhvdb2

Replacement for MHVDB. Needs a better name.
MIT License
4 stars 7 forks source link

Fix README #51

Closed jamiereid closed 10 years ago

jamiereid commented 10 years ago

Make sure that it includes all current views etc.

cmrn commented 10 years ago

I think the readme should be pared down to contain a description, setup and usage instructions, and a reference to contributing.md. The details about the technical design might be better suited to the Github wiki?

brendam commented 10 years ago

Maybe something like http://sphinx-doc.org would be better than the GitHub wiki (tied to GitHub)?

jamiereid commented 10 years ago

Agreed. Pydoc might also be an option http://stackoverflow.com/questions/13040646/how-do-i-create-documentation-with-pydoc

brendam commented 10 years ago

closed by updating Readme.md in 7e68ca33ff3cc10c69d23301325aa5d4fb83b678 Will raise separate issue to add sphinx documentation to project