summaryrefslogtreecommitdiffstats
path: root/doc/index.rst
diff options
context:
space:
mode:
authorThomas Kluyver <takowl@gmail.com>2013-01-05 16:10:21 +0000
committerThomas Kluyver <takowl@gmail.com>2013-01-05 16:10:21 +0000
commitf89cde0eb4f11d525acdaa2bb0edbe8c48117dc3 (patch)
treed792bcad6a872a9158dfe8c091405c01335c6156 /doc/index.rst
parentba2ade314b07f7e16b7860afc621df02f3df46b8 (diff)
Add initial documentation
Diffstat (limited to 'doc/index.rst')
-rw-r--r--doc/index.rst34
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644
index 0000000..2207583
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,34 @@
+WEATBAG contributor information
+===============================
+
+You don't just play WEATBAG, you can take part in creating it too. These docs
+explain how to write new tiles for the game.
+
+The idea is that anything goes, but we do need a few house rules:
+
+1. Don't mess with the real life user or their computer. Deleting files,
+ accessing personal information, sending spam and executing untrusted code are
+ all off limits.
+
+2. The content is in English. If you want to work in another language, you're
+ welcome to take our code and start your own fork.
+
+3. For now, stick to what's provided in the Python 3 standard library. We might
+ allow some extra dependencies later on.
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ interface.rst
+ api_misc.rst
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+