GStreamer multimedia framework
Find a file
2018-09-14 09:35:51 +03:00
examples Android tutorials: 'compile' and 'testCompile' configurations are deprecated 2018-09-07 11:49:01 +03:00
images Split out documentation into subfolders. 2016-11-14 14:10:22 +00:00
markdown markdown: Fix typo in docs (2) 2018-09-14 09:35:51 +03:00
plugins-introspection plugins: add plugin introspection xml files 2016-11-28 23:56:47 +00:00
theme Use official hotdoc_lumen_theme instead of building it ourselves 2018-08-27 15:28:26 -03:00
.gitignore plugins: add script to generate plugins list from module xml files 2016-11-28 23:56:38 +00:00
.gitmodules Use official hotdoc_lumen_theme instead of building it ourselves 2018-08-27 15:28:26 -03:00
hotdoc.json Use official hotdoc_lumen_theme instead of building it ourselves 2018-08-27 15:28:26 -03:00
LICENSE.BSD Add licensing information 2018-05-31 21:15:42 +01:00
LICENSE.CC-BY-SA-4.0 Add licensing information 2018-05-31 21:15:42 +01:00
LICENSE.LGPL-2.1 Add licensing information 2018-05-31 21:15:42 +01:00
LICENSE.MIT Add licensing information 2018-05-31 21:15:42 +01:00
LICENSE.OPL Add licensing information 2018-05-31 21:15:42 +01:00
Makefile Use official hotdoc_lumen_theme instead of building it ourselves 2018-08-27 15:28:26 -03:00
README.md Use official hotdoc_lumen_theme instead of building it ourselves 2018-08-27 15:28:26 -03:00
sitemap.txt design: add RTP design docs from -good 2016-12-10 12:16:43 +00:00
TODO.md Move licensing page over from www module 2016-11-29 10:28:14 +00:00

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, but are still evaluating solutions 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, preferably in a virtualenv.

  • We experimentally use the hotdoc C extension to include functions by name, follow the steps outlined here

  • Build the portal:

make
  • And browse it:
gio open built_doc/html/index.html

Licensing

The content of this module comes from a number of different sources and is licensed in different ways:

Tutorial source code

All tutorial code is licensed under any of the following licenses (your choice):

  • 2-clause BSD license ("simplified BSD license") (LICENSE.BSD)
  • MIT license (LICENSE.MIT)
  • LGPL v2.1 (LICENSE.LGPL-2.1)

This means developers have maximum flexibility and can pick the right license for any derivative work.

Application Developer Manual and Plugin Writer's Guide

These are licensed under the Open Publication License v1.0 (LICENSE.OPL), for historical reasons.

Documentation

Mostly licensed under the Creative Commons CC-BY-SA-4.0 license, but some parts of the documentation may still be licensed differently (e.g. LGPLv2.1) for historical reasons.