README: Enhance and update
authorThibault Saunier <thibault.saunier@osg.samsung.com>
Wed, 26 Oct 2016 20:58:16 +0000 (17:58 -0300)
committerThibault Saunier <thibault.saunier@osg.samsung.com>
Wed, 26 Oct 2016 21:00:55 +0000 (18:00 -0300)
README.md

index d1bf0a064d3d8d97590c44b99c5333239ef1e530..85af59f6de008aa0da2f73ab83150b3aeda9b8bd 100644 (file)
--- 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
 
-NOTE: on fedora (and maybe other distributions) replace `ninja` with `ninja-build`
+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:
 
 ```
-./configure && ninja -C build/
+mkdir build/ && meson build && ninja -C build/
 ```
 
-## GStreamer uninstalled
+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.
+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:
 
-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`.
+```
+ninja -C build/ uninstalled
+```
 
+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/`.