aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSiddhesh Poyarekar <siddhesh@gotplt.org>2024-03-07 13:46:05 -0500
committerSiddhesh Poyarekar <siddhesh@gotplt.org>2024-03-07 16:30:21 -0500
commit22364cfa20156ebdbd035520f64bafa23a9ce462 (patch)
treec046a187d070117307d507b8ed443e71b6327968
parentc093535f6d5ecef5e6795db5150d2b5f79b2fc15 (diff)
downloadcti.coretoolchain.dev-22364cfa20156ebdbd035520f64bafa23a9ce462.tar.gz
Add a toplevel README
Add basic instructions to allow one to test and later submit changes for review and inclusion. Signed-off-by: Siddhesh Poyarekar <siddhesh@gotplt.org> Reviewed-by: Carlos O'Donell <carlos@redhat.com>
-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.