From b2b737dc1b99e46f5206608e4b62de759cf4435c Mon Sep 17 00:00:00 2001 From: Thibault Saunier Date: Wed, 26 Oct 2016 17:58:16 -0300 Subject: [PATCH] README: Enhance and update --- README.md | 44 +++++++++++++++++++++++++++++--------------- 1 file changed, 29 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index d1bf0a064d..85af59f6de 100644 --- a/README.md +++ b/README.md @@ -2,27 +2,41 @@ GStreamer [meson](http://mesonbuild.com/) based repositories aggregrator -You can build GStreamer and all its component at once using -meson and its "subproject" feature. +You can build GStreamer and all its modules at once using +meson and its [subproject](https://github.com/mesonbuild/meson/wiki/Subprojects) feature. ## Getting started -We have an helper script to get started, will get the right [meson](http://mesonbuild.com/) -version and get you ready to build. You can just get all GStreamer built running: +### Install meson and ninja + +You should get meson through your package manager or using: + + $ pip3 install --user meson + +You should get `ninja` using your package manager or downloading it from +[here](https://github.com/ninja-build/ninja/releases). + +### Build GStreamer and its modules + +You can get all GStreamer built running: + +``` +mkdir build/ && meson build && ninja -C build/ +``` NOTE: on fedora (and maybe other distributions) replace `ninja` with `ninja-build` +# Development environment + +gst-build also contains a special `uninstalled` target that lets you enter an +uninstalled development environment where you will be able to work on GStreamer easily. +You can get into that environment running: + ``` -./configure && ninja -C build/ +ninja -C build/ uninstalled ``` -## GStreamer uninstalled - -gst-build also contains a special `uninstalled` target that lets you enter -an uninstalled development environment where you will be able -to work on GStreamer easily. - -Inside that environment you will find the GStreamer modules -in subprojects/, you can simply hack in there and to rebuild you -just need to rerun `ninja`. - +If your operating system handles symlinks, built modules source code will be available +at the root of `gst-build/` for example GStreamer core will be in `gstreamer/`. Otherwise +they will be present in `subprojects/`. You can simply hack in there and to rebuild you +just need to rerun `ninja -C build/`.