aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.txt21
-rw-r--r--index.rst11
2 files changed, 26 insertions, 6 deletions
diff --git a/README.txt b/README.txt
index de34731..764d188 100644
--- a/README.txt
+++ b/README.txt
@@ -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.
diff --git a/index.rst b/index.rst
index 9b0e608..c891c89 100644
--- a/index.rst
+++ b/index.rst
@@ -1,5 +1,5 @@
-Documentation Contents
+Table of Contents
=========================
.. toctree::
@@ -14,10 +14,13 @@ Documentation Contents
porting
source-licensing
-About This Guide
+About The Guide Sources
-------------------------------
-This is sphinx documentation. Build with ``make html``.
+.. include:: README.txt
-The web version is hosted on readthedocs using git hooks for autogeneration.
+Documentation License
+-------------------------------
+
+.. include:: LICENSE