aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..71649d6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# CTI documentation portal
+
+You need `sphinxcontrib-spelling` and `piccolo-theme` to build html pages from
+the rst sources, both of which are available through pip. Once you have them,
+run
+
+```
+make html
+```
+
+To build the html pages for testing.
+
+## Submitting changes
+
+Send your patches to cti-tac@lists.linuxfoundation.org.