From a0d82ec74197bf21e7621cd72361c2155bd2f047 Mon Sep 17 00:00:00 2001
From: Guillaume Gomez <guillaume.gomez@huawei.com>
Date: Fri, 30 Jul 2021 18:03:12 +0200
Subject: [PATCH] Merge README files and crate documentation

---
 gir                                   |  2 +-
 gst-gir-files                         |  2 +-
 gstreamer-app/README.md               | 12 ++++++------
 gstreamer-app/src/lib.rs              |  1 +
 gstreamer-audio/README.md             | 12 ++++++------
 gstreamer-audio/src/lib.rs            |  1 +
 gstreamer-base/README.md              | 12 ++++++------
 gstreamer-base/src/lib.rs             |  1 +
 gstreamer-check/README.md             | 12 ++++++------
 gstreamer-check/src/lib.rs            |  1 +
 gstreamer-controller/README.md        | 12 ++++++------
 gstreamer-controller/src/lib.rs       |  1 +
 gstreamer-editing-services/README.md  | 12 ++++++------
 gstreamer-editing-services/src/lib.rs |  1 +
 gstreamer-gl/README.md                | 10 +++++-----
 gstreamer-gl/src/lib.rs               |  1 +
 gstreamer-net/README.md               | 12 ++++++------
 gstreamer-net/src/lib.rs              |  1 +
 gstreamer-pbutils/README.md           | 12 ++++++------
 gstreamer-pbutils/src/lib.rs          |  1 +
 gstreamer-player/README.md            | 12 ++++++------
 gstreamer-player/src/lib.rs           |  1 +
 gstreamer-rtp/README.md               | 12 ++++++------
 gstreamer-rtp/src/lib.rs              |  1 +
 gstreamer-rtsp-server/README.md       | 12 ++++++------
 gstreamer-rtsp-server/src/lib.rs      |  1 +
 gstreamer-rtsp/README.md              | 12 ++++++------
 gstreamer-rtsp/src/lib.rs             |  1 +
 gstreamer-sdp/README.md               | 12 ++++++------
 gstreamer-sdp/src/lib.rs              |  1 +
 gstreamer-video/README.md             | 12 ++++++------
 gstreamer-video/src/lib.rs            |  1 +
 gstreamer-webrtc/README.md            | 12 ++++++------
 gstreamer-webrtc/src/lib.rs           |  1 +
 gstreamer/README.md                   | 12 ++++++------
 gstreamer/src/lib.rs                  |  1 +
 36 files changed, 120 insertions(+), 103 deletions(-)

diff --git a/gir b/gir
index 1bef39f61..0d08607eb 160000
--- a/gir
+++ b/gir
@@ -1 +1 @@
-Subproject commit 1bef39f6176e84feb082d536ce4ce6e99d85a418
+Subproject commit 0d08607eb5b5a98ae6cb560f1bcaa0a7fadfb4ab
diff --git a/gst-gir-files b/gst-gir-files
index 831b4449f..85bd06bc2 160000
--- a/gst-gir-files
+++ b/gst-gir-files
@@ -1 +1 @@
-Subproject commit 831b4449f0d5d1d30166f40cdf8409c9f395f34d
+Subproject commit 85bd06bc2edad85889d91855cf8b900ad7c3b02f
diff --git a/gstreamer-app/README.md b/gstreamer-app/README.md
index 9f9ed8170..2bcdf4dc1 100644
--- a/gstreamer-app/README.md
+++ b/gstreamer-app/README.md
@@ -38,7 +38,7 @@ package manager, or build them from source.
 
 On Debian/Ubuntu they can be installed with
 
-```
+```shell
 $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \
       gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
       gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly \
@@ -52,7 +52,7 @@ above packages, `libgstreamer-plugins-bad1.0-dev` is installed and
 that the version is >= 1.12. See the `Cargo.toml` files for the full
 details,
 
-```
+```shell
 # Only if you wish to install gstreamer-player, make sure the version
 # of this package is >= 1.12.
 $ apt-get install libgstreamer-plugins-bad1.0-dev
@@ -74,7 +74,7 @@ provided by the GStreamer project.
 Homebrew only installs various plugins if explicitly enabled, so some extra
 `--with-*` flags may be required.
 
-```
+```shell
 $ brew install gstreamer gst-plugins-base gst-plugins-good \
       gst-plugins-bad gst-plugins-ugly gst-libav gst-rtsp-server \
       gst-editing-services --with-orc --with-libogg --with-opus \
@@ -95,7 +95,7 @@ install them, e.g. `gstreamer-1.0-1.12.3-x86_64.pkg` and
 After installation, you also need to install `pkg-config` (e.g. via Homebrew)
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="/Library/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
@@ -110,7 +110,7 @@ the GStreamer project.
 
 #### MSYS2 / pacman
 
-```
+```shell
 $ pacman -S pkg-config mingw-w64-x86_64-gstreamer mingw-w64-x86_64-gst-plugins-base \
       mingw-w64-x86_64-gst-plugins-good mingw-w64-x86_64-gst-plugins-bad \
       mingw-w64-x86_64-gst-plugins-ugly mingw-w64-x86_64-gst-libav \
@@ -131,7 +131,7 @@ After installation, you also need to install `pkg-config` (e.g. via MSYS2 or
 from [here](https://sourceforge.net/projects/pkgconfiglite/))
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
diff --git a/gstreamer-app/src/lib.rs b/gstreamer-app/src/lib.rs
index d577f274b..b1b009f21 100644
--- a/gstreamer-app/src/lib.rs
+++ b/gstreamer-app/src/lib.rs
@@ -1,6 +1,7 @@
 // Take a look at the license at the top of the repository in the LICENSE file.
 
 #![cfg_attr(feature = "dox", feature(doc_cfg))]
+#![doc = include_str!("../README.md")]
 
 pub use ffi;
 pub use glib;
diff --git a/gstreamer-audio/README.md b/gstreamer-audio/README.md
index c0419457d..1187f2591 100644
--- a/gstreamer-audio/README.md
+++ b/gstreamer-audio/README.md
@@ -38,7 +38,7 @@ package manager, or build them from source.
 
 On Debian/Ubuntu they can be installed with
 
-```
+```shell
 $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \
       gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
       gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly \
@@ -52,7 +52,7 @@ above packages, `libgstreamer-plugins-bad1.0-dev` is installed and
 that the version is >= 1.12. See the `Cargo.toml` files for the full
 details,
 
-```
+```shell
 # Only if you wish to install gstreamer-player, make sure the version
 # of this package is >= 1.12.
 $ apt-get install libgstreamer-plugins-bad1.0-dev
@@ -74,7 +74,7 @@ provided by the GStreamer project.
 Homebrew only installs various plugins if explicitly enabled, so some extra
 `--with-*` flags may be required.
 
-```
+```shell
 $ brew install gstreamer gst-plugins-base gst-plugins-good \
       gst-plugins-bad gst-plugins-ugly gst-libav gst-rtsp-server \
       gst-editing-services --with-orc --with-libogg --with-opus \
@@ -95,7 +95,7 @@ install them, e.g. `gstreamer-1.0-1.12.3-x86_64.pkg` and
 After installation, you also need to install `pkg-config` (e.g. via Homebrew)
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="/Library/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
@@ -110,7 +110,7 @@ the GStreamer project.
 
 #### MSYS2 / pacman
 
-```
+```shell
 $ pacman -S pkg-config mingw-w64-x86_64-gstreamer mingw-w64-x86_64-gst-plugins-base \
       mingw-w64-x86_64-gst-plugins-good mingw-w64-x86_64-gst-plugins-bad \
       mingw-w64-x86_64-gst-plugins-ugly mingw-w64-x86_64-gst-libav \
@@ -131,7 +131,7 @@ After installation, you also need to install `pkg-config` (e.g. via MSYS2 or
 from [here](https://sourceforge.net/projects/pkgconfiglite/))
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
diff --git a/gstreamer-audio/src/lib.rs b/gstreamer-audio/src/lib.rs
index aa55639bb..fb06790e1 100644
--- a/gstreamer-audio/src/lib.rs
+++ b/gstreamer-audio/src/lib.rs
@@ -1,6 +1,7 @@
 // Take a look at the license at the top of the repository in the LICENSE file.
 
 #![cfg_attr(feature = "dox", feature(doc_cfg))]
+#![doc = include_str!("../README.md")]
 
 pub use ffi;
 pub use glib;
diff --git a/gstreamer-base/README.md b/gstreamer-base/README.md
index 6a19af0fa..3fb4fc2d4 100644
--- a/gstreamer-base/README.md
+++ b/gstreamer-base/README.md
@@ -38,7 +38,7 @@ package manager, or build them from source.
 
 On Debian/Ubuntu they can be installed with
 
-```
+```shell
 $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \
       gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
       gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly \
@@ -52,7 +52,7 @@ above packages, `libgstreamer-plugins-bad1.0-dev` is installed and
 that the version is >= 1.12. See the `Cargo.toml` files for the full
 details,
 
-```
+```shell
 # Only if you wish to install gstreamer-player, make sure the version
 # of this package is >= 1.12.
 $ apt-get install libgstreamer-plugins-bad1.0-dev
@@ -74,7 +74,7 @@ provided by the GStreamer project.
 Homebrew only installs various plugins if explicitly enabled, so some extra
 `--with-*` flags may be required.
 
-```
+```shell
 $ brew install gstreamer gst-plugins-base gst-plugins-good \
       gst-plugins-bad gst-plugins-ugly gst-libav gst-rtsp-server \
       gst-editing-services --with-orc --with-libogg --with-opus \
@@ -95,7 +95,7 @@ install them, e.g. `gstreamer-1.0-1.12.3-x86_64.pkg` and
 After installation, you also need to install `pkg-config` (e.g. via Homebrew)
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="/Library/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
@@ -110,7 +110,7 @@ the GStreamer project.
 
 #### MSYS2 / pacman
 
-```
+```shell
 $ pacman -S pkg-config mingw-w64-x86_64-gstreamer mingw-w64-x86_64-gst-plugins-base \
       mingw-w64-x86_64-gst-plugins-good mingw-w64-x86_64-gst-plugins-bad \
       mingw-w64-x86_64-gst-plugins-ugly mingw-w64-x86_64-gst-libav \
@@ -131,7 +131,7 @@ After installation, you also need to install `pkg-config` (e.g. via MSYS2 or
 from [here](https://sourceforge.net/projects/pkgconfiglite/))
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
diff --git a/gstreamer-base/src/lib.rs b/gstreamer-base/src/lib.rs
index ad0d195e1..1617bf004 100644
--- a/gstreamer-base/src/lib.rs
+++ b/gstreamer-base/src/lib.rs
@@ -1,6 +1,7 @@
 // Take a look at the license at the top of the repository in the LICENSE file.
 
 #![cfg_attr(feature = "dox", feature(doc_cfg))]
+#![doc = include_str!("../README.md")]
 
 pub use ffi;
 pub use glib;
diff --git a/gstreamer-check/README.md b/gstreamer-check/README.md
index 94a302d21..fa25c1c9f 100644
--- a/gstreamer-check/README.md
+++ b/gstreamer-check/README.md
@@ -38,7 +38,7 @@ package manager, or build them from source.
 
 On Debian/Ubuntu they can be installed with
 
-```
+```shell
 $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \
       gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
       gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly \
@@ -52,7 +52,7 @@ above packages, `libgstreamer-plugins-bad1.0-dev` is installed and
 that the version is >= 1.12. See the `Cargo.toml` files for the full
 details,
 
-```
+```shell
 # Only if you wish to install gstreamer-player, make sure the version
 # of this package is >= 1.12.
 $ apt-get install libgstreamer-plugins-bad1.0-dev
@@ -74,7 +74,7 @@ provided by the GStreamer project.
 Homebrew only installs various plugins if explicitly enabled, so some extra
 `--with-*` flags may be required.
 
-```
+```shell
 $ brew install gstreamer gst-plugins-base gst-plugins-good \
       gst-plugins-bad gst-plugins-ugly gst-libav gst-rtsp-server \
       gst-editing-services --with-orc --with-libogg --with-opus \
@@ -95,7 +95,7 @@ install them, e.g. `gstreamer-1.0-1.12.3-x86_64.pkg` and
 After installation, you also need to install `pkg-config` (e.g. via Homebrew)
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="/Library/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
@@ -110,7 +110,7 @@ the GStreamer project.
 
 #### MSYS2 / pacman
 
-```
+```shell
 $ pacman -S pkg-config mingw-w64-x86_64-gstreamer mingw-w64-x86_64-gst-plugins-base \
       mingw-w64-x86_64-gst-plugins-good mingw-w64-x86_64-gst-plugins-bad \
       mingw-w64-x86_64-gst-plugins-ugly mingw-w64-x86_64-gst-libav \
@@ -131,7 +131,7 @@ After installation, you also need to install `pkg-config` (e.g. via MSYS2 or
 from [here](https://sourceforge.net/projects/pkgconfiglite/))
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
diff --git a/gstreamer-check/src/lib.rs b/gstreamer-check/src/lib.rs
index 60b937d08..9a65f579c 100644
--- a/gstreamer-check/src/lib.rs
+++ b/gstreamer-check/src/lib.rs
@@ -1,6 +1,7 @@
 // Take a look at the license at the top of the repository in the LICENSE file.
 
 #![cfg_attr(feature = "dox", feature(doc_cfg))]
+#![doc = include_str!("../README.md")]
 
 pub use ffi;
 pub use glib;
diff --git a/gstreamer-controller/README.md b/gstreamer-controller/README.md
index 701faaa35..8341bc3b6 100644
--- a/gstreamer-controller/README.md
+++ b/gstreamer-controller/README.md
@@ -38,7 +38,7 @@ package manager, or build them from source.
 
 On Debian/Ubuntu they can be installed with
 
-```
+```shell
 $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \
       gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
       gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly \
@@ -52,7 +52,7 @@ above packages, `libgstreamer-plugins-bad1.0-dev` is installed and
 that the version is >= 1.12. See the `Cargo.toml` files for the full
 details,
 
-```
+```shell
 # Only if you wish to install gstreamer-player, make sure the version
 # of this package is >= 1.12.
 $ apt-get install libgstreamer-plugins-bad1.0-dev
@@ -74,7 +74,7 @@ provided by the GStreamer project.
 Homebrew only installs various plugins if explicitly enabled, so some extra
 `--with-*` flags may be required.
 
-```
+```shell
 $ brew install gstreamer gst-plugins-base gst-plugins-good \
       gst-plugins-bad gst-plugins-ugly gst-libav gst-rtsp-server \
       gst-editing-services --with-orc --with-libogg --with-opus \
@@ -95,7 +95,7 @@ install them, e.g. `gstreamer-1.0-1.12.3-x86_64.pkg` and
 After installation, you also need to install `pkg-config` (e.g. via Homebrew)
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="/Library/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
@@ -110,7 +110,7 @@ the GStreamer project.
 
 #### MSYS2 / pacman
 
-```
+```shell
 $ pacman -S pkg-config mingw-w64-x86_64-gstreamer mingw-w64-x86_64-gst-plugins-base \
       mingw-w64-x86_64-gst-plugins-good mingw-w64-x86_64-gst-plugins-bad \
       mingw-w64-x86_64-gst-plugins-ugly mingw-w64-x86_64-gst-libav \
@@ -131,7 +131,7 @@ After installation, you also need to install `pkg-config` (e.g. via MSYS2 or
 from [here](https://sourceforge.net/projects/pkgconfiglite/))
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
diff --git a/gstreamer-controller/src/lib.rs b/gstreamer-controller/src/lib.rs
index 7819b83a3..5168e7ad1 100644
--- a/gstreamer-controller/src/lib.rs
+++ b/gstreamer-controller/src/lib.rs
@@ -1,6 +1,7 @@
 // Take a look at the license at the top of the repository in the LICENSE file.
 
 #![cfg_attr(feature = "dox", feature(doc_cfg))]
+#![doc = include_str!("../README.md")]
 
 pub use ffi;
 pub use glib;
diff --git a/gstreamer-editing-services/README.md b/gstreamer-editing-services/README.md
index 3ae77ed71..d0a889ffe 100644
--- a/gstreamer-editing-services/README.md
+++ b/gstreamer-editing-services/README.md
@@ -43,7 +43,7 @@ package manager, or build them from source.
 
 On Debian/Ubuntu they can be installed with
 
-```
+```shell
 $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \
       gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
       gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly \
@@ -57,7 +57,7 @@ above packages, `libgstreamer-plugins-bad1.0-dev` is installed and
 that the version is >= 1.12. See the `Cargo.toml` files for the full
 details,
 
-```
+```shell
 # Only if you wish to install gstreamer-player, make sure the version
 # of this package is >= 1.12.
 $ apt-get install libgstreamer-plugins-bad1.0-dev
@@ -79,7 +79,7 @@ provided by the GStreamer project.
 Homebrew only installs various plugins if explicitly enabled, so some extra
 `--with-*` flags may be required.
 
-```
+```shell
 $ brew install gstreamer gst-plugins-base gst-plugins-good \
       gst-plugins-bad gst-plugins-ugly gst-libav gst-rtsp-server \
       gst-editing-services --with-orc --with-libogg --with-opus \
@@ -100,7 +100,7 @@ install them, e.g. `gstreamer-1.0-1.12.3-x86_64.pkg` and
 After installation, you also need to install `pkg-config` (e.g. via Homebrew)
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="/Library/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
@@ -115,7 +115,7 @@ the GStreamer project.
 
 #### MSYS2 / pacman
 
-```
+```shell
 $ pacman -S pkg-config mingw-w64-x86_64-gstreamer mingw-w64-x86_64-gst-plugins-base \
       mingw-w64-x86_64-gst-plugins-good mingw-w64-x86_64-gst-plugins-bad \
       mingw-w64-x86_64-gst-plugins-ugly mingw-w64-x86_64-gst-libav \
@@ -136,7 +136,7 @@ After installation, you also need to install `pkg-config` (e.g. via MSYS2 or
 from [here](https://sourceforge.net/projects/pkgconfiglite/))
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
diff --git a/gstreamer-editing-services/src/lib.rs b/gstreamer-editing-services/src/lib.rs
index ed5e28633..37f5e55a6 100644
--- a/gstreamer-editing-services/src/lib.rs
+++ b/gstreamer-editing-services/src/lib.rs
@@ -1,6 +1,7 @@
 // Take a look at the license at the top of the repository in the LICENSE file.
 
 #![cfg_attr(feature = "dox", feature(doc_cfg))]
+#![doc = include_str!("../README.md")]
 
 pub use ffi;
 pub use gio;
diff --git a/gstreamer-gl/README.md b/gstreamer-gl/README.md
index ffd8e8e5a..c315018a7 100644
--- a/gstreamer-gl/README.md
+++ b/gstreamer-gl/README.md
@@ -40,7 +40,7 @@ package manager, or build them from source.
 
 On Debian/Ubuntu they can be installed with
 
-```
+```shell
 $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \
       gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
       gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly \
@@ -66,7 +66,7 @@ provided by the GStreamer project.
 Homebrew only installs various plugins if explicitly enabled, so some extra
 `--with-*` flags may be required.
 
-```
+```shell
 $ brew install gstreamer gst-plugins-base gst-plugins-good \
       gst-plugins-bad gst-plugins-ugly gst-libav gst-rtsp-server \
       gst-editing-services --with-orc --with-libogg --with-opus \
@@ -85,7 +85,7 @@ install them, e.g. `gstreamer-1.0-1.14.4-x86_64.pkg` and
 After installation, you also need to install `pkg-config` (e.g. via Homebrew)
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="/Library/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
@@ -100,7 +100,7 @@ the GStreamer project.
 
 #### MSYS2 / pacman
 
-```
+```shell
 $ pacman -S pkg-config mingw-w64-x86_64-gstreamer mingw-w64-x86_64-gst-plugins-base \
       mingw-w64-x86_64-gst-plugins-good mingw-w64-x86_64-gst-plugins-bad \
       mingw-w64-x86_64-gst-plugins-ugly mingw-w64-x86_64-gst-libav \
@@ -119,7 +119,7 @@ After installation, you also need to install `pkg-config` (e.g. via MSYS2 or
 from [here](https://sourceforge.net/projects/pkgconfiglite/))
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
diff --git a/gstreamer-gl/src/lib.rs b/gstreamer-gl/src/lib.rs
index d9e80c133..9cd3b6d59 100644
--- a/gstreamer-gl/src/lib.rs
+++ b/gstreamer-gl/src/lib.rs
@@ -1,6 +1,7 @@
 // Take a look at the license at the top of the repository in the LICENSE file.
 
 #![cfg_attr(feature = "dox", feature(doc_cfg))]
+#![doc = include_str!("../README.md")]
 
 pub use ffi;
 pub use glib;
diff --git a/gstreamer-net/README.md b/gstreamer-net/README.md
index 4934c0a10..1c29cf1a6 100644
--- a/gstreamer-net/README.md
+++ b/gstreamer-net/README.md
@@ -38,7 +38,7 @@ package manager, or build them from source.
 
 On Debian/Ubuntu they can be installed with
 
-```
+```shell
 $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \
       gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
       gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly \
@@ -52,7 +52,7 @@ above packages, `libgstreamer-plugins-bad1.0-dev` is installed and
 that the version is >= 1.12. See the `Cargo.toml` files for the full
 details,
 
-```
+```shell
 # Only if you wish to install gstreamer-player, make sure the version
 # of this package is >= 1.12.
 $ apt-get install libgstreamer-plugins-bad1.0-dev
@@ -74,7 +74,7 @@ provided by the GStreamer project.
 Homebrew only installs various plugins if explicitly enabled, so some extra
 `--with-*` flags may be required.
 
-```
+```shell
 $ brew install gstreamer gst-plugins-base gst-plugins-good \
       gst-plugins-bad gst-plugins-ugly gst-libav gst-rtsp-server \
       gst-editing-services --with-orc --with-libogg --with-opus \
@@ -95,7 +95,7 @@ install them, e.g. `gstreamer-1.0-1.12.3-x86_64.pkg` and
 After installation, you also need to install `pkg-config` (e.g. via Homebrew)
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="/Library/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
@@ -110,7 +110,7 @@ the GStreamer project.
 
 #### MSYS2 / pacman
 
-```
+```shell
 $ pacman -S pkg-config mingw-w64-x86_64-gstreamer mingw-w64-x86_64-gst-plugins-base \
       mingw-w64-x86_64-gst-plugins-good mingw-w64-x86_64-gst-plugins-bad \
       mingw-w64-x86_64-gst-plugins-ugly mingw-w64-x86_64-gst-libav \
@@ -131,7 +131,7 @@ After installation, you also need to install `pkg-config` (e.g. via MSYS2 or
 from [here](https://sourceforge.net/projects/pkgconfiglite/))
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
diff --git a/gstreamer-net/src/lib.rs b/gstreamer-net/src/lib.rs
index a411de0a2..793ea65ac 100644
--- a/gstreamer-net/src/lib.rs
+++ b/gstreamer-net/src/lib.rs
@@ -1,6 +1,7 @@
 // Take a look at the license at the top of the repository in the LICENSE file.
 
 #![cfg_attr(feature = "dox", feature(doc_cfg))]
+#![doc = include_str!("../README.md")]
 
 pub use ffi;
 pub use gio;
diff --git a/gstreamer-pbutils/README.md b/gstreamer-pbutils/README.md
index 398b5d0d1..97ae19a66 100644
--- a/gstreamer-pbutils/README.md
+++ b/gstreamer-pbutils/README.md
@@ -38,7 +38,7 @@ package manager, or build them from source.
 
 On Debian/Ubuntu they can be installed with
 
-```
+```shell
 $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \
       gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
       gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly \
@@ -52,7 +52,7 @@ above packages, `libgstreamer-plugins-bad1.0-dev` is installed and
 that the version is >= 1.12. See the `Cargo.toml` files for the full
 details,
 
-```
+```shell
 # Only if you wish to install gstreamer-player, make sure the version
 # of this package is >= 1.12.
 $ apt-get install libgstreamer-plugins-bad1.0-dev
@@ -74,7 +74,7 @@ provided by the GStreamer project.
 Homebrew only installs various plugins if explicitly enabled, so some extra
 `--with-*` flags may be required.
 
-```
+```shell
 $ brew install gstreamer gst-plugins-base gst-plugins-good \
       gst-plugins-bad gst-plugins-ugly gst-libav gst-rtsp-server \
       gst-editing-services --with-orc --with-libogg --with-opus \
@@ -95,7 +95,7 @@ install them, e.g. `gstreamer-1.0-1.12.3-x86_64.pkg` and
 After installation, you also need to install `pkg-config` (e.g. via Homebrew)
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="/Library/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
@@ -110,7 +110,7 @@ the GStreamer project.
 
 #### MSYS2 / pacman
 
-```
+```shell
 $ pacman -S pkg-config mingw-w64-x86_64-gstreamer mingw-w64-x86_64-gst-plugins-base \
       mingw-w64-x86_64-gst-plugins-good mingw-w64-x86_64-gst-plugins-bad \
       mingw-w64-x86_64-gst-plugins-ugly mingw-w64-x86_64-gst-libav \
@@ -131,7 +131,7 @@ After installation, you also need to install `pkg-config` (e.g. via MSYS2 or
 from [here](https://sourceforge.net/projects/pkgconfiglite/))
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
diff --git a/gstreamer-pbutils/src/lib.rs b/gstreamer-pbutils/src/lib.rs
index 0aed314c6..c59410bb1 100644
--- a/gstreamer-pbutils/src/lib.rs
+++ b/gstreamer-pbutils/src/lib.rs
@@ -1,6 +1,7 @@
 // Take a look at the license at the top of the repository in the LICENSE file.
 
 #![cfg_attr(feature = "dox", feature(doc_cfg))]
+#![doc = include_str!("../README.md")]
 
 pub use ffi;
 pub use glib;
diff --git a/gstreamer-player/README.md b/gstreamer-player/README.md
index 086b712a4..10145e7d0 100644
--- a/gstreamer-player/README.md
+++ b/gstreamer-player/README.md
@@ -38,7 +38,7 @@ package manager, or build them from source.
 
 On Debian/Ubuntu they can be installed with
 
-```
+```shell
 $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \
       gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
       gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly \
@@ -52,7 +52,7 @@ above packages, `libgstreamer-plugins-bad1.0-dev` is installed and
 that the version is >= 1.12. See the `Cargo.toml` files for the full
 details,
 
-```
+```shell
 # Only if you wish to install gstreamer-player, make sure the version
 # of this package is >= 1.12.
 $ apt-get install libgstreamer-plugins-bad1.0-dev
@@ -74,7 +74,7 @@ provided by the GStreamer project.
 Homebrew only installs various plugins if explicitly enabled, so some extra
 `--with-*` flags may be required.
 
-```
+```shell
 $ brew install gstreamer gst-plugins-base gst-plugins-good \
       gst-plugins-bad gst-plugins-ugly gst-libav gst-rtsp-server \
       gst-editing-services --with-orc --with-libogg --with-opus \
@@ -95,7 +95,7 @@ install them, e.g. `gstreamer-1.0-1.12.3-x86_64.pkg` and
 After installation, you also need to install `pkg-config` (e.g. via Homebrew)
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="/Library/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
@@ -110,7 +110,7 @@ the GStreamer project.
 
 #### MSYS2 / pacman
 
-```
+```shell
 $ pacman -S pkg-config mingw-w64-x86_64-gstreamer mingw-w64-x86_64-gst-plugins-base \
       mingw-w64-x86_64-gst-plugins-good mingw-w64-x86_64-gst-plugins-bad \
       mingw-w64-x86_64-gst-plugins-ugly mingw-w64-x86_64-gst-libav \
@@ -131,7 +131,7 @@ After installation, you also need to install `pkg-config` (e.g. via MSYS2 or
 from [here](https://sourceforge.net/projects/pkgconfiglite/))
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
diff --git a/gstreamer-player/src/lib.rs b/gstreamer-player/src/lib.rs
index 403612185..770d7e324 100644
--- a/gstreamer-player/src/lib.rs
+++ b/gstreamer-player/src/lib.rs
@@ -1,6 +1,7 @@
 // Take a look at the license at the top of the repository in the LICENSE file.
 
 #![cfg_attr(feature = "dox", feature(doc_cfg))]
+#![doc = include_str!("../README.md")]
 
 pub use ffi;
 pub use gst;
diff --git a/gstreamer-rtp/README.md b/gstreamer-rtp/README.md
index 108048ab1..199690285 100644
--- a/gstreamer-rtp/README.md
+++ b/gstreamer-rtp/README.md
@@ -38,7 +38,7 @@ package manager, or build them from source.
 
 On Debian/Ubuntu they can be installed with
 
-```
+```shell
 $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \
       gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
       gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly \
@@ -52,7 +52,7 @@ above packages, `libgstreamer-plugins-bad1.0-dev` is installed and
 that the version is >= 1.12. See the `Cargo.toml` files for the full
 details,
 
-```
+```shell
 # Only if you wish to install gstreamer-player, make sure the version
 # of this package is >= 1.12.
 $ apt-get install libgstreamer-plugins-bad1.0-dev
@@ -74,7 +74,7 @@ provided by the GStreamer project.
 Homebrew only installs various plugins if explicitly enabled, so some extra
 `--with-*` flags may be required.
 
-```
+```shell
 $ brew install gstreamer gst-plugins-base gst-plugins-good \
       gst-plugins-bad gst-plugins-ugly gst-libav gst-rtsp-server \
       gst-editing-services --with-orc --with-libogg --with-opus \
@@ -95,7 +95,7 @@ install them, e.g. `gstreamer-1.0-1.12.3-x86_64.pkg` and
 After installation, you also need to install `pkg-config` (e.g. via Homebrew)
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="/Library/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
@@ -110,7 +110,7 @@ the GStreamer project.
 
 #### MSYS2 / pacman
 
-```
+```shell
 $ pacman -S pkg-config mingw-w64-x86_64-gstreamer mingw-w64-x86_64-gst-plugins-base \
       mingw-w64-x86_64-gst-plugins-good mingw-w64-x86_64-gst-plugins-bad \
       mingw-w64-x86_64-gst-plugins-ugly mingw-w64-x86_64-gst-libav \
@@ -131,7 +131,7 @@ After installation, you also need to install `pkg-config` (e.g. via MSYS2 or
 from [here](https://sourceforge.net/projects/pkgconfiglite/))
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
diff --git a/gstreamer-rtp/src/lib.rs b/gstreamer-rtp/src/lib.rs
index 5c2231a2f..dd79502bd 100644
--- a/gstreamer-rtp/src/lib.rs
+++ b/gstreamer-rtp/src/lib.rs
@@ -1,6 +1,7 @@
 // Take a look at the license at the top of the repository in the LICENSE file.
 
 #![cfg_attr(feature = "dox", feature(doc_cfg))]
+#![doc = include_str!("../README.md")]
 
 pub use ffi;
 pub use glib;
diff --git a/gstreamer-rtsp-server/README.md b/gstreamer-rtsp-server/README.md
index 241b33d3f..2ba49ffde 100644
--- a/gstreamer-rtsp-server/README.md
+++ b/gstreamer-rtsp-server/README.md
@@ -38,7 +38,7 @@ package manager, or build them from source.
 
 On Debian/Ubuntu they can be installed with
 
-```
+```shell
 $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \
       gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
       gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly \
@@ -52,7 +52,7 @@ above packages, `libgstreamer-plugins-bad1.0-dev` is installed and
 that the version is >= 1.12. See the `Cargo.toml` files for the full
 details,
 
-```
+```shell
 # Only if you wish to install gstreamer-player, make sure the version
 # of this package is >= 1.12.
 $ apt-get install libgstreamer-plugins-bad1.0-dev
@@ -74,7 +74,7 @@ provided by the GStreamer project.
 Homebrew only installs various plugins if explicitly enabled, so some extra
 `--with-*` flags may be required.
 
-```
+```shell
 $ brew install gstreamer gst-plugins-base gst-plugins-good \
       gst-plugins-bad gst-plugins-ugly gst-libav gst-rtsp-server \
       gst-editing-services --with-orc --with-libogg --with-opus \
@@ -95,7 +95,7 @@ install them, e.g. `gstreamer-1.0-1.12.3-x86_64.pkg` and
 After installation, you also need to install `pkg-config` (e.g. via Homebrew)
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="/Library/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
@@ -110,7 +110,7 @@ the GStreamer project.
 
 #### MSYS2 / pacman
 
-```
+```shell
 $ pacman -S pkg-config mingw-w64-x86_64-gstreamer mingw-w64-x86_64-gst-plugins-base \
       mingw-w64-x86_64-gst-plugins-good mingw-w64-x86_64-gst-plugins-bad \
       mingw-w64-x86_64-gst-plugins-ugly mingw-w64-x86_64-gst-libav \
@@ -131,7 +131,7 @@ After installation, you also need to install `pkg-config` (e.g. via MSYS2 or
 from [here](https://sourceforge.net/projects/pkgconfiglite/))
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
diff --git a/gstreamer-rtsp-server/src/lib.rs b/gstreamer-rtsp-server/src/lib.rs
index c792bf7ee..c38ad7cda 100644
--- a/gstreamer-rtsp-server/src/lib.rs
+++ b/gstreamer-rtsp-server/src/lib.rs
@@ -1,6 +1,7 @@
 // Take a look at the license at the top of the repository in the LICENSE file.
 
 #![cfg_attr(feature = "dox", feature(doc_cfg))]
+#![doc = include_str!("../README.md")]
 
 pub use ffi;
 pub use gio;
diff --git a/gstreamer-rtsp/README.md b/gstreamer-rtsp/README.md
index efe46fbca..eee44edfa 100644
--- a/gstreamer-rtsp/README.md
+++ b/gstreamer-rtsp/README.md
@@ -38,7 +38,7 @@ package manager, or build them from source.
 
 On Debian/Ubuntu they can be installed with
 
-```
+```shell
 $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \
       gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
       gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly \
@@ -52,7 +52,7 @@ above packages, `libgstreamer-plugins-bad1.0-dev` is installed and
 that the version is >= 1.12. See the `Cargo.toml` files for the full
 details,
 
-```
+```shell
 # Only if you wish to install gstreamer-player, make sure the version
 # of this package is >= 1.12.
 $ apt-get install libgstreamer-plugins-bad1.0-dev
@@ -74,7 +74,7 @@ provided by the GStreamer project.
 Homebrew only installs various plugins if explicitly enabled, so some extra
 `--with-*` flags may be required.
 
-```
+```shell
 $ brew install gstreamer gst-plugins-base gst-plugins-good \
       gst-plugins-bad gst-plugins-ugly gst-libav gst-rtsp-server \
       gst-editing-services --with-orc --with-libogg --with-opus \
@@ -95,7 +95,7 @@ install them, e.g. `gstreamer-1.0-1.12.3-x86_64.pkg` and
 After installation, you also need to install `pkg-config` (e.g. via Homebrew)
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="/Library/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
@@ -110,7 +110,7 @@ the GStreamer project.
 
 #### MSYS2 / pacman
 
-```
+```shell
 $ pacman -S pkg-config mingw-w64-x86_64-gstreamer mingw-w64-x86_64-gst-plugins-base \
       mingw-w64-x86_64-gst-plugins-good mingw-w64-x86_64-gst-plugins-bad \
       mingw-w64-x86_64-gst-plugins-ugly mingw-w64-x86_64-gst-libav \
@@ -131,7 +131,7 @@ After installation, you also need to install `pkg-config` (e.g. via MSYS2 or
 from [here](https://sourceforge.net/projects/pkgconfiglite/))
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
diff --git a/gstreamer-rtsp/src/lib.rs b/gstreamer-rtsp/src/lib.rs
index d3f0b9107..881ffcf9d 100644
--- a/gstreamer-rtsp/src/lib.rs
+++ b/gstreamer-rtsp/src/lib.rs
@@ -1,6 +1,7 @@
 // Take a look at the license at the top of the repository in the LICENSE file.
 
 #![cfg_attr(feature = "dox", feature(doc_cfg))]
+#![doc = include_str!("../README.md")]
 
 pub use ffi;
 pub use glib;
diff --git a/gstreamer-sdp/README.md b/gstreamer-sdp/README.md
index 385ceab59..2cb52ca30 100644
--- a/gstreamer-sdp/README.md
+++ b/gstreamer-sdp/README.md
@@ -38,7 +38,7 @@ package manager, or build them from source.
 
 On Debian/Ubuntu they can be installed with
 
-```
+```shell
 $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \
       gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
       gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly \
@@ -52,7 +52,7 @@ above packages, `libgstreamer-plugins-bad1.0-dev` is installed and
 that the version is >= 1.12. See the `Cargo.toml` files for the full
 details,
 
-```
+```shell
 # Only if you wish to install gstreamer-player, make sure the version
 # of this package is >= 1.12.
 $ apt-get install libgstreamer-plugins-bad1.0-dev
@@ -74,7 +74,7 @@ provided by the GStreamer project.
 Homebrew only installs various plugins if explicitly enabled, so some extra
 `--with-*` flags may be required.
 
-```
+```shell
 $ brew install gstreamer gst-plugins-base gst-plugins-good \
       gst-plugins-bad gst-plugins-ugly gst-libav gst-rtsp-server \
       gst-editing-services --with-orc --with-libogg --with-opus \
@@ -95,7 +95,7 @@ install them, e.g. `gstreamer-1.0-1.12.3-x86_64.pkg` and
 After installation, you also need to install `pkg-config` (e.g. via Homebrew)
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="/Library/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
@@ -110,7 +110,7 @@ the GStreamer project.
 
 #### MSYS2 / pacman
 
-```
+```shell
 $ pacman -S pkg-config mingw-w64-x86_64-gstreamer mingw-w64-x86_64-gst-plugins-base \
       mingw-w64-x86_64-gst-plugins-good mingw-w64-x86_64-gst-plugins-bad \
       mingw-w64-x86_64-gst-plugins-ugly mingw-w64-x86_64-gst-libav \
@@ -131,7 +131,7 @@ After installation, you also need to install `pkg-config` (e.g. via MSYS2 or
 from [here](https://sourceforge.net/projects/pkgconfiglite/))
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
diff --git a/gstreamer-sdp/src/lib.rs b/gstreamer-sdp/src/lib.rs
index c35612b22..4bd960d8c 100644
--- a/gstreamer-sdp/src/lib.rs
+++ b/gstreamer-sdp/src/lib.rs
@@ -1,6 +1,7 @@
 // Take a look at the license at the top of the repository in the LICENSE file.
 
 #![cfg_attr(feature = "dox", feature(doc_cfg))]
+#![doc = include_str!("../README.md")]
 
 pub use ffi;
 pub use glib;
diff --git a/gstreamer-video/README.md b/gstreamer-video/README.md
index 0a277cc92..41351fc32 100644
--- a/gstreamer-video/README.md
+++ b/gstreamer-video/README.md
@@ -38,7 +38,7 @@ package manager, or build them from source.
 
 On Debian/Ubuntu they can be installed with
 
-```
+```shell
 $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \
       gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
       gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly \
@@ -52,7 +52,7 @@ above packages, `libgstreamer-plugins-bad1.0-dev` is installed and
 that the version is >= 1.12. See the `Cargo.toml` files for the full
 details,
 
-```
+```shell
 # Only if you wish to install gstreamer-player, make sure the version
 # of this package is >= 1.12.
 $ apt-get install libgstreamer-plugins-bad1.0-dev
@@ -74,7 +74,7 @@ provided by the GStreamer project.
 Homebrew only installs various plugins if explicitly enabled, so some extra
 `--with-*` flags may be required.
 
-```
+```shell
 $ brew install gstreamer gst-plugins-base gst-plugins-good \
       gst-plugins-bad gst-plugins-ugly gst-libav gst-rtsp-server \
       gst-editing-services --with-orc --with-libogg --with-opus \
@@ -95,7 +95,7 @@ install them, e.g. `gstreamer-1.0-1.12.3-x86_64.pkg` and
 After installation, you also need to install `pkg-config` (e.g. via Homebrew)
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="/Library/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
@@ -110,7 +110,7 @@ the GStreamer project.
 
 #### MSYS2 / pacman
 
-```
+```shell
 $ pacman -S pkg-config mingw-w64-x86_64-gstreamer mingw-w64-x86_64-gst-plugins-base \
       mingw-w64-x86_64-gst-plugins-good mingw-w64-x86_64-gst-plugins-bad \
       mingw-w64-x86_64-gst-plugins-ugly mingw-w64-x86_64-gst-libav \
@@ -131,7 +131,7 @@ After installation, you also need to install `pkg-config` (e.g. via MSYS2 or
 from [here](https://sourceforge.net/projects/pkgconfiglite/))
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
diff --git a/gstreamer-video/src/lib.rs b/gstreamer-video/src/lib.rs
index b65589b23..57067953b 100644
--- a/gstreamer-video/src/lib.rs
+++ b/gstreamer-video/src/lib.rs
@@ -1,6 +1,7 @@
 // Take a look at the license at the top of the repository in the LICENSE file.
 
 #![cfg_attr(feature = "dox", feature(doc_cfg))]
+#![doc = include_str!("../README.md")]
 
 pub use ffi;
 pub use glib;
diff --git a/gstreamer-webrtc/README.md b/gstreamer-webrtc/README.md
index 22f63c83d..aa21ce195 100644
--- a/gstreamer-webrtc/README.md
+++ b/gstreamer-webrtc/README.md
@@ -38,7 +38,7 @@ package manager, or build them from source.
 
 On Debian/Ubuntu they can be installed with
 
-```
+```shell
 $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \
       gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
       gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly \
@@ -52,7 +52,7 @@ above packages, `libgstreamer-plugins-bad1.0-dev` is installed and
 that the version is >= 1.12. See the `Cargo.toml` files for the full
 details,
 
-```
+```shell
 # Only if you wish to install gstreamer-player, make sure the version
 # of this package is >= 1.12.
 $ apt-get install libgstreamer-plugins-bad1.0-dev
@@ -74,7 +74,7 @@ provided by the GStreamer project.
 Homebrew only installs various plugins if explicitly enabled, so some extra
 `--with-*` flags may be required.
 
-```
+```shell
 $ brew install gstreamer gst-plugins-base gst-plugins-good \
       gst-plugins-bad gst-plugins-ugly gst-libav gst-rtsp-server \
       gst-editing-services --with-orc --with-libogg --with-opus \
@@ -95,7 +95,7 @@ install them, e.g. `gstreamer-1.0-1.12.3-x86_64.pkg` and
 After installation, you also need to install `pkg-config` (e.g. via Homebrew)
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="/Library/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
@@ -110,7 +110,7 @@ the GStreamer project.
 
 #### MSYS2 / pacman
 
-```
+```shell
 $ pacman -S pkg-config mingw-w64-x86_64-gstreamer mingw-w64-x86_64-gst-plugins-base \
       mingw-w64-x86_64-gst-plugins-good mingw-w64-x86_64-gst-plugins-bad \
       mingw-w64-x86_64-gst-plugins-ugly mingw-w64-x86_64-gst-libav \
@@ -131,7 +131,7 @@ After installation, you also need to install `pkg-config` (e.g. via MSYS2 or
 from [here](https://sourceforge.net/projects/pkgconfiglite/))
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
diff --git a/gstreamer-webrtc/src/lib.rs b/gstreamer-webrtc/src/lib.rs
index ffda903f9..661fe6e40 100644
--- a/gstreamer-webrtc/src/lib.rs
+++ b/gstreamer-webrtc/src/lib.rs
@@ -1,6 +1,7 @@
 // Take a look at the license at the top of the repository in the LICENSE file.
 
 #![cfg_attr(feature = "dox", feature(doc_cfg))]
+#![doc = include_str!("../README.md")]
 
 pub use ffi;
 pub use glib;
diff --git a/gstreamer/README.md b/gstreamer/README.md
index ec08a7a31..75428e123 100644
--- a/gstreamer/README.md
+++ b/gstreamer/README.md
@@ -38,7 +38,7 @@ package manager, or build them from source.
 
 On Debian/Ubuntu they can be installed with
 
-```
+```shell
 $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \
       gstreamer1.0-plugins-base gstreamer1.0-plugins-good \
       gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly \
@@ -52,7 +52,7 @@ above packages, `libgstreamer-plugins-bad1.0-dev` is installed and
 that the version is >= 1.12. See the `Cargo.toml` files for the full
 details,
 
-```
+```shell
 # Only if you wish to install gstreamer-player, make sure the version
 # of this package is >= 1.12.
 $ apt-get install libgstreamer-plugins-bad1.0-dev
@@ -74,7 +74,7 @@ provided by the GStreamer project.
 Homebrew only installs various plugins if explicitly enabled, so some extra
 `--with-*` flags may be required.
 
-```
+```shell
 $ brew install gstreamer gst-plugins-base gst-plugins-good \
       gst-plugins-bad gst-plugins-ugly gst-libav gst-rtsp-server \
       gst-editing-services --with-orc --with-libogg --with-opus \
@@ -95,7 +95,7 @@ install them, e.g. `gstreamer-1.0-1.12.3-x86_64.pkg` and
 After installation, you also need to install `pkg-config` (e.g. via Homebrew)
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="/Library/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
@@ -110,7 +110,7 @@ the GStreamer project.
 
 #### MSYS2 / pacman
 
-```
+```shell
 $ pacman -S pkg-config mingw-w64-x86_64-gstreamer mingw-w64-x86_64-gst-plugins-base \
       mingw-w64-x86_64-gst-plugins-good mingw-w64-x86_64-gst-plugins-bad \
       mingw-w64-x86_64-gst-plugins-ugly mingw-w64-x86_64-gst-libav \
@@ -131,7 +131,7 @@ After installation, you also need to install `pkg-config` (e.g. via MSYS2 or
 from [here](https://sourceforge.net/projects/pkgconfiglite/))
 and set the `PKG_CONFIG_PATH` environment variable
 
-```
+```shell
 $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
 ```
 
diff --git a/gstreamer/src/lib.rs b/gstreamer/src/lib.rs
index c7bba9257..309b582c6 100644
--- a/gstreamer/src/lib.rs
+++ b/gstreamer/src/lib.rs
@@ -2,6 +2,7 @@
 
 #![cfg_attr(feature = "dox", feature(doc_cfg))]
 #![recursion_limit = "256"]
+#![doc = include_str!("../README.md")]
 
 // Re-exported for the subclass gst_plugin_define! macro
 pub use ffi;