summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorng0 <ng0@n0.is>2019-12-08 10:37:19 +0000
committerng0 <ng0@n0.is>2019-12-08 10:37:19 +0000
commit22216ab267e7139a1e476fdad7f0193778aed4c8 (patch)
tree320927112269c2851d0bd65c0baebb3785ce385c
parent2e0504d54bb8e7b8776bca92a8a24dc17fb0c73f (diff)
downloadwww_shared-22216ab267e7139a1e476fdad7f0193778aed4c8.tar.gz
www_shared-22216ab267e7139a1e476fdad7f0193778aed4c8.zip
merge README.text and README
-rw-r--r--README27
-rw-r--r--README.text21
2 files changed, 20 insertions, 28 deletions
diff --git a/README b/README
deleted file mode 100644
index d1a6159..0000000
--- a/README
+++ /dev/null
@@ -1,27 +0,0 @@
1www_shared
2==========
3
4Shared code between taler.net and gnunet.org to build a jinja2-based
5website.
6
7This code provides building blocks for generating the html pages and
8other repeating tasks.
9
10Usage
11-----
12
13The code expects to sit in 'inc', which for gnunet.org is the folder
14where this submodule is checked out to. For more practical
15applications of it refer to the source code of gnunet.org.
16
17Dependencies
18------------
19
20python3, jinja2, BeautifulSoup 4, ruamel.yaml
21
22License
23-------
24Everything in here is to be placed in the public domain, due to
25ambiguity of "public domain" in some countries the code is 0-BSD
26licensed.
27New code should follow this licensing choice.
diff --git a/README.text b/README.text
index fed16ea..d9650ce 100644
--- a/README.text
+++ b/README.text
@@ -1,12 +1,31 @@
1www_shared
2==========
1Common shared components for the websites of GNUnet and Taler. 3Common shared components for the websites of GNUnet and Taler.
2 4
3This is meant to be imported by a jinja2 project with a 5This is meant to be imported by a jinja2 project with a
4structure equivalent to https://git.gnunet.org/www.git 6structure equivalent to https://git.gnunet.org/www.git
5or https://git.taler.net/www.git. 7or https://git.taler.net/www.git.
6 8
9Usage
10-----
11
12The code expects to sit in 'inc', which for gnunet.org is the folder
13where this submodule is checked out to. For more practical
14applications of it refer to the source code of gnunet.org.
15
7Changes to this code must be usable outside of the structure 16Changes to this code must be usable outside of the structure
8of one website, ie this affects both websites and if in doubt 17of one website, ie this affects both websites and if in doubt
9should be tested against both as soon as both websites have 18should be tested against both as soon as both websites have
10been switched to this code. 19been switched to this code.
11 20
12Code should be mostly 0BSD / Public Domain. 21Dependencies
22------------
23
24python3, jinja2, BeautifulSoup 4, ruamel.yaml
25
26License
27-------
28Everything in here is to be placed in the public domain, due to
29ambiguity of "public domain" in some countries the code is 0-BSD
30licensed.
31New code should follow this licensing choice.