diff options
author | ng0 <ng0@n0.is> | 2019-02-21 10:50:41 +0000 |
---|---|---|
committer | ng0 <ng0@n0.is> | 2019-02-21 10:50:41 +0000 |
commit | 040bd258123e48afd3a767c8ecea375af8e3ff48 (patch) | |
tree | 4784c70267eefb6526113c884541128d311c898f | |
parent | a224152d0330624c99e36e0fb457656d2ebd53c6 (diff) | |
download | www-040bd258123e48afd3a767c8ecea375af8e3ff48.tar.gz www-040bd258123e48afd3a767c8ecea375af8e3ff48.zip |
README: document structure
-rw-r--r-- | README | 30 |
1 files changed, 24 insertions, 6 deletions
@@ -6,12 +6,30 @@ Sourcecode for https://gnunet.org created from the https://taler.net code base. | |||
6 | 6 | ||
7 | Requires python3-jinja2, python3-babel, and gettext. | 7 | Requires python3-jinja2, python3-babel, and gettext. |
8 | 8 | ||
9 | Run "make" or "gmake" to build the HTML. | 9 | The currently supported python3 version is python 3.7. |
10 | In old USB fashion, run make or gmake again if it fails (we might fix this | 10 | |
11 | eventually). | 11 | Run "make" to build the HTML. |
12 | 12 | If you experience a failure related to a python module, run | |
13 | Expect it to show up in en/ and other language folders, NOT in the root dir. | 13 | "make" again. |
14 | 14 | ||
15 | Expect it to show up in rendered/en/ and other language folders. | ||
16 | |||
17 | Layout / how this comes to be | ||
18 | ============================= | ||
19 | |||
20 | config.mk local variables for values in the Makefile | ||
21 | static/ contains images, css, PDFs, robots.txt, team-images | ||
22 | static/navbar.css CSS for the navigation bar (common/navigation.j2.inc) | ||
23 | static/styles.css CSS for the rest of the website | ||
24 | template/ the flat namespace of html.j2 files | ||
25 | dist/ 3rd party content (bootstrap 4, font-awesome) | ||
26 | common/ jinja2 templates. | ||
27 | template.py operates on template directory and produces | ||
28 | output in 'rendered/' directory | ||
29 | |||
30 | The 'dist' and 'static' directories will be copied to the output | ||
31 | directory ('rendered/') in the 'all' phase of make. robots.txt | ||
32 | is copied to relevant folders. | ||
15 | 33 | ||
16 | Developing with GNU Guix | 34 | Developing with GNU Guix |
17 | ======================== | 35 | ======================== |