3 This is a collection of design documents, formerly maintained in various
4 different locations and formats, now grouped together and converted
11 We will follow the commonmark specification.
13 We *should* try to follow this
14 [style guide](http://www.cirosantilli.com/markdown-style-guide/#about),
15 but are still [evaluating solutions](https://github.com/jgm/cmark/issues/131)
16 for *stable* automatic formatting.
18 80 columns line width is thus not yet enforced, but strongly suggested.
20 # Build a web portal from the sources
22 ## Install dependencies
24 * Follow [hotdoc's installation guide](https://people.collabora.com/~meh/hotdoc_hotdoc/html/installing.html),
25 preferably in a virtualenv.
27 * We *experimentally* use the hotdoc C extension to include functions by
28 name, follow the steps outlined [here](https://github.com/hotdoc/hotdoc_c_extension)
30 * We recompile and override hotdoc's default theme, which is a submodule of this project:
33 git submodule update --init
36 Follow the instructions outlined in the theme's README.md, you can dispense
37 with the last step (building the theme):
40 cd theme/hotdoc_bootstrap_theme
41 sudo dnf install nodejs # On Fedora
42 sudo apt-get install nodejs nodejs-legacy npm # debian
43 sudo pacman -S nodejs npm # arch
44 npm install && ./node_modules/bower/bin/bower install
57 xdg-open built_doc/html/index.html
62 The content of this module comes from a number of different sources and is
63 licensed in different ways:
65 ### Tutorial source code
67 All tutorial code is licensed under any of the following licenses (your choice):
69 - 2-clause BSD license ("simplified BSD license") (`LICENSE.BSD`)
70 - MIT license (`LICENSE.MIT`)
71 - LGPL v2.1 (`LICENSE.LGPL-2.1`)
73 This means developers have maximum flexibility and can pick the right license
74 for any derivative work.
76 ### Application Developer Manual and Plugin Writer's Guide
78 These are licensed under the [Open Publication License v1.0][op-license]
79 (`LICENSE.OPL`), for historical reasons.
81 [op-license]: http://www.opencontent.org/openpub/
85 Mostly licensed under the [Creative Commons CC-BY-SA-4.0 license][cc-by-sa-4.0],
86 but some parts of the documentation may still be licensed differently
87 (e.g. LGPLv2.1) for historical reasons.
89 [cc-by-sa-4.0]: https://creativecommons.org/licenses/by-sa/4.0/