summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThien-Thi Nguyen <ttn@gnuvola.org>2021-11-29 03:49:07 -0500
committerThien-Thi Nguyen <ttn@gnuvola.org>2021-11-29 03:49:07 -0500
commit3a6d578805fc741baabef59aa6ecafc7fe7c7188 (patch)
tree9fddf7df45de1ded7c35607578d9f348c5d1706c
parentdccfbcca392bf461ceb0587331cff2e3e21f197d (diff)
downloaddocs-3a6d578805fc741baabef59aa6ecafc7fe7c7188.tar.gz
docs-3a6d578805fc741baabef59aa6ecafc7fe7c7188.tar.bz2
docs-3a6d578805fc741baabef59aa6ecafc7fe7c7188.zip
Rewrite top-level README
There is a TODO item in the README now, as well.
-rw-r--r--README17
1 files changed, 12 insertions, 5 deletions
diff --git a/README b/README
index b7f6414..dda29a2 100644
--- a/README
+++ b/README
@@ -1,10 +1,17 @@
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:
+To build things on a Debian (-based) system, install these packages:
+ - make
+ - python3-sphinx
+ - python3-recommonmark
+ - graphviz
+ - texlive-latex-extra
+ - dvipng
-$ pip3 install --user --upgrade recommonmark sphinx
+Then, do "make html" for HTML, "make texinfo" for Texinfo, etc.
+(Do "make" w/o a target to see a list of possible targets.)
-Note by Buck: when setting up on VM, I also needed:
+The output is in subdir ‘_build’.
-# apt install texlive-latex-extra graphviz
+
+TODO: Add instructions on how to build/export/integrate ‘prebuilt’ docs.