aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README34
1 files changed, 26 insertions, 8 deletions
diff --git a/README b/README
index 93bbd086..d65adf74 100644
--- a/README
+++ b/README
@@ -2,31 +2,49 @@
2GNUnet Website 2GNUnet Website
3============== 3==============
4 4
5Sourcecode for https://gnunet.org created from the https://taler.net code base. 5Sourcecode for https://gnunet.org created from the https://taler.net
6code base.
6 7
7Requirements 8Requirements
8------------ 9------------
9- python3 modules: 10- python3 modules:
10 - python3-jinja2, python3-babel 11 - python3-jinja2, python3-babel
11- python3 interpreter: 12- python3 interpreter:
12 - python 3.7 (although any 3.x version should work) 13 - python 3.7 or later.
13- gettext 14- gettext
14- sassc, to compile the stylesheets 15- sassc, to compile the stylesheets
15 16
17general short buildsteps:
16 18
17Run "make" to build the HTML. 19 ./bootstrap
18If you experience a failure related to a python module, run 20 ./configure
19"make" again. 21 make
20 22
21Expect it to show up in rendered/en/ and other language folders. 23'configure' takes arguments, run ./configure --help or ./configure -h
24to find out what could be fitting for you. Generally configure tries
25to be smart about detecting names, if it doesn't find them for you,
26you should report this as a bug.
27
28GNU make operates on "GNUmakefile", "Makefile" is used by at least
29NetBSD make in this context (we do get a speed improvement by
30writing different files with different structures optimized for
31the make implementation).
32
33Running "make" builds the HTML.
34Expect its output to show up in rendered/en/ and other language
35folders.
22 36
23Run the following to start a python webserver: 37Run the following to start a python webserver:
24BROWSER=firefox make run 38
39 make run
40or
41
42 BROWSER=firefox make run
25 43
26Layout / how this comes to be 44Layout / how this comes to be
27============================= 45=============================
28 46
29config.mk local variables for values in the Makefile 47config.mk autogenerated file by taler-build-scripts
30static/ contains images, css, PDFs, robots.txt, team-images 48static/ contains images, css, PDFs, robots.txt, team-images
31static/navbar.css CSS for the navigation bar (common/navigation.j2.inc) 49static/navbar.css CSS for the navigation bar (common/navigation.j2.inc)
32static/styles.css CSS for the rest of the website 50static/styles.css CSS for the rest of the website