summaryrefslogtreecommitdiff
path: root/doc/sphinx/README
diff options
context:
space:
mode:
Diffstat (limited to 'doc/sphinx/README')
-rw-r--r--doc/sphinx/README10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/sphinx/README b/doc/sphinx/README
new file mode 100644
index 0000000..b7f6414
--- /dev/null
+++ b/doc/sphinx/README
@@ -0,0 +1,10 @@
+This repository contains the documentation for all main GNU Taler components.
+
+Before building the documentation, make sure that you have the required
+dependencies installed using pip3:
+
+$ pip3 install --user --upgrade recommonmark sphinx
+
+Note by Buck: when setting up on VM, I also needed:
+
+# apt install texlive-latex-extra graphviz