proper README

2 files changed, 49 insertions, 0 deletions

diff --git a/AUTHORS b/AUTHORS
new file mode 100644
index 0000000..92f286c
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1,5 @@
+ng0
+Florian Dold
+Christian Grothoff
+Marcello Stanisci
+Julian Kirsch
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/
+  ??