Remove ChangeLog files from git repository

[platform/upstream/gstreamer.git] / README.md

diff --git a/README.md b/README.md
index 4130d25..e68a515 100644 (file)
--- a/README.md
+++ b/README.md
@@ -53,6 +53,20 @@ binary in your PATH.
 
 You can find [instructions for Windows below](#windows-prerequisites-setup).
 
+
+On macOS, you might need to execute "Install Certificates.command" from the
+Python folder in the user Applications folder:
+
+```
+$ /Applications/Python\ 3.*/Install\ Certificates.command
+```
+
+Otherwise you will get this error when downloading meson wraps:
+
+```
+urllib.error.URLError: urlopen error [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed
+```
+
 ### Build GStreamer and its modules
 
 You can get all GStreamer built running:
@@ -205,9 +219,25 @@ All the selected features will be registered into a dedicated `NULL` plugin name
 
 This will cause the features/plugins that are not registered to not be included in the final gstreamer-full library.
 
-This is an experimental feature, backward uncompatible changes could still be
+This is an experimental feature, backward incompatible changes could still be
 made in the future.
 
+### Building documentation
+
+Documentation is not built by default because it is slow to generate. To build
+the documentation, first ensure that `hotdoc` is installed and `doc` option is
+enabled. For API documentation, gobject introspection must also be enabled.
+The special target `gst-doc` can then be used to (re)generate the documentation.
+
+```
+pip install hotdoc
+meson setup -Ddoc=enabled -Dintrospection=enabled builddir
+ninja -C builddir gst-doc
+```
+
+NOTE: To visualize the documentation, `devhelp` can be run inside the development
+environment (see below).
+
 # Development environment
 
 ## Development environment target
@@ -234,6 +264,9 @@ An external script can be run in development environment with:
 ./gst-env.py external_script.sh
 ```
 
+For more extensive documentation about the development environment go to [the
+documentation](https://gstreamer.freedesktop.org/documentation/installing/building-from-source-using-meson.html).
+
 ## Custom subprojects
 
 We also added a meson option, `custom_subprojects`, that allows the user