diff options
| author | bnewbold <bnewbold@robocracy.org> | 2015-01-07 01:09:10 +0000 |
|---|---|---|
| committer | bnewbold <bnewbold@robocracy.org> | 2015-01-07 01:09:10 +0000 |
| commit | b5cf3fcc82d4f3258f2b66dbc1c90426aa62e98d (patch) | |
| tree | c301fec8346b3c0fa9bf0144cc61c64bdca3e05e /README.txt | |
| parent | fe2fa580a67ce018b69523293b531daab033221c (diff) | |
| download | novena-guide-b5cf3fcc82d4f3258f2b66dbc1c90426aa62e98d.tar.gz novena-guide-b5cf3fcc82d4f3258f2b66dbc1c90426aa62e98d.zip | |
update README and front page
Diffstat (limited to 'README.txt')
| -rw-r--r-- | README.txt | 21 |
1 files changed, 19 insertions, 2 deletions
@@ -1,4 +1,21 @@ -This is sphinx documentation. Build with ``make html``. +This is Sphinx-based documentation, built from reStructured Text sources. Build +locally with ``make html`` (you'll need the ``python-sphinx`` package or +equivalent on your platform). The output will pop out at +``_build/html/index.html``. -The web version is hosted on readthedocs using git hooks for autogeneration. +The live version (currently at http://novena-guide.readthedocs.org/) is hosted +by ReadTheDocs using github hooks for auto builds. For context, and pointers +for how to make changes and contributions, see +http://docs.readthedocs.com. + +The sources are hosted at https://github.com/bnewbold/novena-guide. +Contributions by patch or pull-request are welcome! Please indicate that you +agree with the licensing terms. If you don't want to use the github system, you +can send patches or plain text corrections or comments to "bnewbold" at the +domain of "robocracy.org". + +The documentation infrastructure supports both multiple variants (eg, tweaked +docs for derivative or future hardware) and translations. If you'd like to help +with a translation it's probably best to get in touch first to make sure +efforts aren't duplicated. |