summaryrefslogtreecommitdiff
path: root/doc/README.md
diff options
context:
space:
mode:
authorNathaniel Graff <nathaniel.graff@sifive.com>2019-01-29 13:32:11 -0800
committerNathaniel Graff <nathaniel.graff@sifive.com>2019-02-06 11:09:41 -0800
commit0df6996fcbd3cdfbb7614b4fcc7e83e41cea1f23 (patch)
treeb4f9020ccad976c5afef67384be7177bdd0e95e3 /doc/README.md
parent4c20f5158e506f3c13cf66d5259a6399a6b4b2a3 (diff)
Init Sphinx docs for E SDK
Signed-off-by: Nathaniel Graff <nathaniel.graff@sifive.com>
Diffstat (limited to 'doc/README.md')
-rw-r--r--doc/README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 0000000..9fd78df
--- /dev/null
+++ b/doc/README.md
@@ -0,0 +1,41 @@
+# Documentation Generation
+
+## Requirements
+
+You'll need the following software:
+- [Sphinx](http://www.sphinx-doc.org/en/master/index.html)
+
+### Ubuntu
+
+You can install the required software on Ubuntu with the following:
+
+```
+sudo apt install python3-sphinx
+```
+
+The second line can be omitted if you don't intend to build the PDF.
+
+### MacOS
+
+You can install the required software on MacOS with the following:
+
+```
+brew install sphinx-doc
+```
+
+The second line can be omitted if you don't intend to build the PDF.
+
+## Building the Docs
+
+You can generate the HTML documentation with
+```
+make
+```
+
+You can clean the build files and outputs with
+
+```
+make clean
+```
+
+