summaryrefslogtreecommitdiff
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 @@
GNUnet Website
==============
-Sourcecode for https://gnunet.org created from the https://taler.net code base.
+Sourcecode for https://gnunet.org created from the https://taler.net
+code base.
Requirements
------------
- python3 modules:
- python3-jinja2, python3-babel
- python3 interpreter:
- - python 3.7 (although any 3.x version should work)
+ - python 3.7 or later.
- gettext
- sassc, to compile the stylesheets
+general short buildsteps:
-Run "make" to build the HTML.
-If you experience a failure related to a python module, run
-"make" again.
+ ./bootstrap
+ ./configure
+ make
-Expect it to show up in rendered/en/ and other language folders.
+'configure' takes arguments, run ./configure --help or ./configure -h
+to find out what could be fitting for you. Generally configure tries
+to be smart about detecting names, if it doesn't find them for you,
+you should report this as a bug.
+
+GNU make operates on "GNUmakefile", "Makefile" is used by at least
+NetBSD make in this context (we do get a speed improvement by
+writing different files with different structures optimized for
+the make implementation).
+
+Running "make" builds the HTML.
+Expect its output to show up in rendered/en/ and other language
+folders.
Run the following to start a python webserver:
-BROWSER=firefox make run
+
+ make run
+or
+
+ BROWSER=firefox make run
Layout / how this comes to be
=============================
-config.mk local variables for values in the Makefile
+config.mk autogenerated file by taler-build-scripts
static/ contains images, css, PDFs, robots.txt, team-images
static/navbar.css CSS for the navigation bar (common/navigation.j2.inc)
static/styles.css CSS for the rest of the website