[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] branch master updated: Rewrite top-level README
From: |
gnunet |
Subject: |
[taler-docs] branch master updated: Rewrite top-level README |
Date: |
Mon, 29 Nov 2021 09:52:51 +0100 |
This is an automated email from the git hooks/post-receive script.
ttn pushed a commit to branch master
in repository docs.
The following commit(s) were added to refs/heads/master by this push:
new 3a6d578 Rewrite top-level README
3a6d578 is described below
commit 3a6d578805fc741baabef59aa6ecafc7fe7c7188
Author: Thien-Thi Nguyen <ttn@gnuvola.org>
AuthorDate: Mon Nov 29 03:49:07 2021 -0500
Rewrite top-level README
There is a TODO item in the README now, as well.
---
README | 17 ++++++++++++-----
1 file 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.
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [taler-docs] branch master updated: Rewrite top-level README,
gnunet <=