Remove ChangeLog files from git repository

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

diff --git a/README.md b/README.md
index c727de1..e68a515 100644 (file)
--- a/README.md
+++ b/README.md
@@ -54,14 +54,14 @@ 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 or install it manually:
+On macOS, you might need to execute "Install Certificates.command" from the
+Python folder in the user Applications folder:
 
 ```
-  $ pip3 install certifi
+$ /Applications/Python\ 3.*/Install\ Certificates.command
 ```
 
-It will solve this issue:
+Otherwise you will get this error when downloading meson wraps:
 
 ```
 urllib.error.URLError: urlopen error [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed
@@ -222,6 +222,22 @@ This will cause the features/plugins that are not registered to not be included
 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