mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-27 10:40:34 +00:00
Code Issues 1 Projects Releases Wiki Activity
GStreamer multimedia framework
769 commits 44 branches 1510 tags 333 MiB
C 81%
C++ 10.1%
C# 4.6%
Python 1.6%
Meson 0.9%
Other 1.4%
Find a file
Jacques de Broin c25c296760 gst-docs: add return value to appsink callback in tutorial and example code 
The "crude waveform generator" sample application in "Basic
tutorial 8: Short-cutting the pipeline" was lacking the return value
so it was only being invoked once.

https://bugzilla.gnome.org/show_bug.cgi?id=796476
2018-06-05 08:50:14 +03:00
examples gst-docs: add return value to appsink callback in tutorial and example code 2018-06-05 08:50:14 +03:00
images Split out documentation into subfolders. 2016-11-14 14:10:22 +00:00
markdown gst-docs: add return value to appsink callback in tutorial and example code 2018-06-05 08:50:14 +03:00
plugins-introspection plugins: add plugin introspection xml files 2016-11-28 23:56:47 +00:00
theme Update theme submodule 2017-04-25 02:17:21 +02:00
.gitignore plugins: add script to generate plugins list from module xml files 2016-11-28 23:56:38 +00:00
.gitmodules Split out documentation into subfolders. 2016-11-14 14:10:22 +00:00
hotdoc.json Add project version as it is now required by hotdoc 2017-04-05 09:50:37 -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 Makefile: check for hotdoc before attempting upload 2016-12-08 07:38:41 +00:00
README.md Add licensing information 2018-05-31 21:15:42 +01: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

README.md

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

  • We recompile and override hotdoc's default theme, which is a submodule of this project:

git submodule update --init

Follow the instructions outlined in the theme's README.md, you can dispense with the last step (building the theme):

cd theme/hotdoc_bootstrap_theme
sudo dnf install nodejs # On Fedora
sudo apt-get install nodejs nodejs-legacy npm # debian
sudo pacman -S nodejs npm # arch
npm install && ./node_modules/bower/bin/bower install
cd ../..
  • Build the portal:
make
  • And browse it:
xdg-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.