update docu

2 files changed, 53 insertions, 8 deletions

diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..ff92ac4
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,35 @@
+Installation instructions
+-------------------------
+
+For Debian:
+===========
+
+Simply install:
+
+# apt-install python3-ruamel.yaml python3-jinja2 python3-babel git node-typescript
+
+Then invoke "bootstrap" and "configure". You must pass
+"--prefix=$P" and "--variant=$V" for some values of
+$P and $V to configure.  The actual Web site
+will be installed at $P/$V.
+
+
+For NetBSD:
+===========
+
+Install python3.8, py38-babel, npm, nodejs from pkgsrc.
+
+Adjust the values in config.mk:
+
+       PYTHON=python3.8
+       BABEL=pybabel-3.8
+
+npm install typescript
+Add the node_module's bin to your $PATH for the typescript binary.
+make submodules/init
+make submodules/update
+make
+
+If you installed typescript in $HOME:
+PATH=$HOME/node_modules/.bin/:$PATH env BROWSER=firefox make run
+to run the website
diff --git a/README b/README
index 8974620..687b361 100644
--- a/README
+++ b/README
@@ -1,11 +1,21 @@
-This repository just contains the auditor's standalone Web site.
-The actual auditing logic is part of the 'exchange.git' repository.
+This repository contains a template for a simple auditor Web site.
 
-To build the auditor web page stand alone, make sure you have GNUnet 
-installed (e.g. via apt install gnunet) for the required gnunet-ecc
-support, and run the following steps from the repository root:
+The Web site consists of basically static HTML. However, the static HTML is
+run through the Jinja2 template processor for internationalization.
 
-$ git submodule init
-$ git submodule update --remote
-$ make
+Structure:
 
+INSTALL contains instructions for how to generate the HTML page(s).
+
+template/
+  Basically, you edit the English "*.html.j2" files in template/, and then run
+  the Python script to generate static HTML.  To facilitate translation, all
+  English text in the HTML is marked for GNU Gettext using Jinja2 mark-up.
+
+locale/
+  The translations of the strings into the various languages are in the
+  locale/ directory.
+
+inc/
+  This directory contains various Python scripts that are included during
+  the pre-processing with Jinja2.