summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2019-12-22 23:41:51 +0100
committerChristian Grothoff <christian@grothoff.org>2019-12-22 23:41:51 +0100
commit276e8f45459a74d8d6e2523fd7148a5ea0d84208 (patch)
tree00378961c917710d8b77eecccc75eba21a1e368f /README
parent4a91388a6fb43a72d4402ba99b4445d4595552cb (diff)
downloadwww-276e8f45459a74d8d6e2523fd7148a5ea0d84208.tar.gz
www-276e8f45459a74d8d6e2523fd7148a5ea0d84208.tar.bz2
www-276e8f45459a74d8d6e2523fd7148a5ea0d84208.zip
proper README
Diffstat (limited to 'README')
-rw-r--r--README44
1 files changed, 44 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..cf99de6
--- /dev/null
+++ b/README
@@ -0,0 +1,44 @@
+This repository contains the main GNU Taler Web site.
+
+The Web site consists of basically static HTML. However, the static HTML is
+run through the Jinja2 template processor for internationalization.
+
+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.
+
+common/
+ This directory contains files shared between the various HTML pages, such
+ as our navigation bar.
+
+locale/
+ The translations of the strings into the various languages are in the
+ locale/ directory.
+
+
+dist/
+ This directory contains JavaScript from other projects which we redistribute,
+ such as bootstrap and jquery.
+
+
+static/
+ This directory contains static resources that are language-independent
+ and never change.
+
+
+news/ and financial-news/
+ This directory contains news items to be posted on the news page.
+
+
+inc/
+ This directory contains various Python scripts that are included during
+ the pre-processing with Jinja2.
+
+
+help/
+ ??