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