mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-20 08:41:07 +00:00
Add a README
Feel free to change it if disagreeing, but having something can't hurt :)
This commit is contained in:
parent
07c4cc7ddc
commit
2b89969d95
1 changed files with 43 additions and 0 deletions
43
README
Normal file
43
README
Normal file
|
@ -0,0 +1,43 @@
|
||||||
|
# Introduction
|
||||||
|
|
||||||
|
This is a collection of design documents, formerly maintained in various
|
||||||
|
different locations and formats, now grouped together and converted
|
||||||
|
to commonmark.
|
||||||
|
|
||||||
|
# Contributing
|
||||||
|
|
||||||
|
## Style
|
||||||
|
|
||||||
|
We will follow the commonmark specification.
|
||||||
|
|
||||||
|
We *should* try to follow this
|
||||||
|
[style guide](http://www.cirosantilli.com/markdown-style-guide/#about),
|
||||||
|
but are still [evaluating solutions](https://github.com/jgm/cmark/issues/131)
|
||||||
|
for *stable* automatic formatting.
|
||||||
|
|
||||||
|
80 columns line width is thus not yet enforced, but strongly suggested.
|
||||||
|
|
||||||
|
# Build a web portal from the sources
|
||||||
|
|
||||||
|
## Install dependencies
|
||||||
|
|
||||||
|
* Follow [hotdoc's installation guide](https://people.collabora.com/~meh/hotdoc_hotdoc/html/installing.html),
|
||||||
|
preferably in a virtualenv.
|
||||||
|
|
||||||
|
* Optionally install the `hotdoc_search_extension`:
|
||||||
|
|
||||||
|
```
|
||||||
|
pip install hotdoc-search-extension
|
||||||
|
```
|
||||||
|
|
||||||
|
* Build the portal:
|
||||||
|
|
||||||
|
```
|
||||||
|
hotdoc run
|
||||||
|
```
|
||||||
|
|
||||||
|
* And browse it:
|
||||||
|
|
||||||
|
```
|
||||||
|
xdg-open build/html/index.html
|
||||||
|
```
|
Loading…
Reference in a new issue