From 3a6d578805fc741baabef59aa6ecafc7fe7c7188 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Mon, 29 Nov 2021 03:49:07 -0500 Subject: Rewrite top-level README There is a TODO item in the README now, as well. --- README | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) (limited to 'README') diff --git a/README b/README index b7f64144..dda29a28 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. -- cgit v1.2.3