Add readme

metaborg · Feb 26, 2016 · cd99a36 · cd99a36
1 parent e7a759f
commit cd99a36
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,17 @@
+# Spoofax documentation
+
+This repository contains Spoofax documentation made with [Sphinx](http://www.sphinx-doc.org/en/stable/).
+
+## Building
+
+To build the documentation, use the Makefile:
+
+```
+make html
+```
+
+Sphinx requires Python, at least version 2.6. To install the required Python packages, run:
+
+```
+pip install -r requirements.txt
+```
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,3 @@
+sphinx
+sphinx-autobuild
+recommonmark