README

   1 # Introduction
   2
   3 This is a collection of design documents, formerly maintained in various
   4 different locations and formats, now grouped together and converted
   5 to commonmark.
   6
   7 # Contributing
   8
   9 ## Style
  10
  11 We will follow the commonmark specification.
  12
  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.
  17
  18 80 columns line width is thus not yet enforced, but strongly suggested.
  19
  20 # Build a web portal from the sources
  21
  22 ## Install dependencies
  23
  24 * Follow [hotdoc's installation guide](https://people.collabora.com/~meh/hotdoc_hotdoc/html/installing.html),
  25   preferably in a virtualenv.
  26
  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)
  29
  30 * We recompile and override hotdoc's default theme, which is a submodule of this project:
  31
  32 ```
  33 git submodule update --init
  34 ```
  35
  36 Follow the instructions outlined in the theme's README.md, you can dispense
  37 with the last step (building the theme):
  38
  39 ```
  40 cd hotdoc_bootstrap_theme
  41 sudo dnf install nodejs # On Fedora
  42 npm install && ./node_modules/bower/bin/bower install
  43 cd ..
  44 ```
  45
  46 * Build the portal:
  47
  48 ```
  49 make
  50 ```
  51
  52 * And browse it:
  53
  54 ```
  55 xdg-open build/html/index.html
  56 ```