From 22364cfa20156ebdbd035520f64bafa23a9ce462 Mon Sep 17 00:00:00 2001 From: Siddhesh Poyarekar Date: Thu, 7 Mar 2024 13:46:05 -0500 Subject: 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 Reviewed-by: Carlos O'Donell --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md 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. -- cgit 1.2.3-korg