diff --git a/README.md b/README.md index cc4131cc6..0a6507573 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,17 @@ The API of the two is incompatible. A crate for writing GStreamer plugins in Rust can be found here: https://github.com/sdroege/gst-plugin-rs +## Table of Contents +1. [Installation](#installation) + 1. [Linux/BSDs](#installation-linux) + 1. [macOS](#installation-macos) + 1. [Windows](#installation-windows) +1. [Getting Started](#getting-started) +1. [License](#license) +1. [Contribution](#contribution) + + + ## Installation To build the GStreamer bindings or anything depending on them, you need to @@ -24,6 +35,8 @@ some of the examples/tutorials require various GStreamer plugins to be available, which can be found in gst-plugins-base, gst-plugins-good, gst-plugins-bad, gst-plugins-ugly and/or gst-libav. + + ### Linux/BSDs You need to install the above mentioned packages with your distributions @@ -41,6 +54,8 @@ $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \ Package names on other distributions should be similar. Please submit a pull request with instructions for yours. + + ### macOS You can install GStreamer and the plugins via [Homebrew](https://brew.sh/) or @@ -67,6 +82,8 @@ and set the `PKG_CONFIG_PATH` environment variable $ export PKG_CONFIG_PATH="/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}" ``` + + ### Windows You can install GStreamer and the plugins via [MSYS2](http://www.msys2.org/) @@ -96,6 +113,8 @@ and set the `PKG_CONFIG_PATH` environment variable $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}" ``` + + ## Getting Started The API reference can be found @@ -123,6 +142,8 @@ Rust can be found in the [examples](https://github.com/sdroege/gstreamer-rs/tree/master/examples) directory. + + ## LICENSE gstreamer-rs and all crates contained in here are licensed under either of @@ -138,6 +159,8 @@ GStreamer itself is licensed under the Lesser General Public License version 2.1 or (at your option) any later version: https://www.gnu.org/licenses/lgpl-2.1.html + + ## Contribution Any kinds of contributions are welcome as a pull request. diff --git a/gstreamer-app/README.md b/gstreamer-app/README.md index 9258c1495..93fffe35e 100644 --- a/gstreamer-app/README.md +++ b/gstreamer-app/README.md @@ -16,6 +16,17 @@ The API of the two is incompatible. A crate for writing GStreamer plugins in Rust can be found here: https://github.com/sdroege/gst-plugin-rs +## Table of Contents +1. [Installation](#installation) + 1. [Linux/BSDs](#installation-linux) + 1. [macOS](#installation-macos) + 1. [Windows](#installation-windows) +1. [Getting Started](#getting-started) +1. [License](#license) +1. [Contribution](#contribution) + + + ## Installation To build the GStreamer bindings or anything depending on them, you need to @@ -24,6 +35,8 @@ some of the examples/tutorials require various GStreamer plugins to be available, which can be found in gst-plugins-base, gst-plugins-good, gst-plugins-bad, gst-plugins-ugly and/or gst-libav. + + ### Linux/BSDs You need to install the above mentioned packages with your distributions @@ -41,6 +54,8 @@ $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \ Package names on other distributions should be similar. Please submit a pull request with instructions for yours. + + ### macOS You can install GStreamer and the plugins via [Homebrew](https://brew.sh/) or @@ -67,6 +82,8 @@ and set the `PKG_CONFIG_PATH` environment variable $ export PKG_CONFIG_PATH="/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}" ``` + + ### Windows You can install GStreamer and the plugins via [MSYS2](http://www.msys2.org/) @@ -96,6 +113,8 @@ and set the `PKG_CONFIG_PATH` environment variable $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}" ``` + + ## Getting Started The API reference can be found @@ -123,6 +142,8 @@ Rust can be found in the [examples](https://github.com/sdroege/gstreamer-rs/tree/master/examples) directory. + + ## LICENSE gstreamer-rs and all crates contained in here are licensed under either of @@ -138,6 +159,8 @@ GStreamer itself is licensed under the Lesser General Public License version 2.1 or (at your option) any later version: https://www.gnu.org/licenses/lgpl-2.1.html + + ## Contribution Any kinds of contributions are welcome as a pull request. diff --git a/gstreamer-audio/README.md b/gstreamer-audio/README.md index 086666a30..d51ead3c9 100644 --- a/gstreamer-audio/README.md +++ b/gstreamer-audio/README.md @@ -16,6 +16,17 @@ The API of the two is incompatible. A crate for writing GStreamer plugins in Rust can be found here: https://github.com/sdroege/gst-plugin-rs +## Table of Contents +1. [Installation](#installation) + 1. [Linux/BSDs](#installation-linux) + 1. [macOS](#installation-macos) + 1. [Windows](#installation-windows) +1. [Getting Started](#getting-started) +1. [License](#license) +1. [Contribution](#contribution) + + + ## Installation To build the GStreamer bindings or anything depending on them, you need to @@ -24,6 +35,8 @@ some of the examples/tutorials require various GStreamer plugins to be available, which can be found in gst-plugins-base, gst-plugins-good, gst-plugins-bad, gst-plugins-ugly and/or gst-libav. + + ### Linux/BSDs You need to install the above mentioned packages with your distributions @@ -41,6 +54,8 @@ $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \ Package names on other distributions should be similar. Please submit a pull request with instructions for yours. + + ### macOS You can install GStreamer and the plugins via [Homebrew](https://brew.sh/) or @@ -67,6 +82,8 @@ and set the `PKG_CONFIG_PATH` environment variable $ export PKG_CONFIG_PATH="/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}" ``` + + ### Windows You can install GStreamer and the plugins via [MSYS2](http://www.msys2.org/) @@ -96,6 +113,8 @@ and set the `PKG_CONFIG_PATH` environment variable $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}" ``` + + ## Getting Started The API reference can be found @@ -123,6 +142,8 @@ Rust can be found in the [examples](https://github.com/sdroege/gstreamer-rs/tree/master/examples) directory. + + ## LICENSE gstreamer-rs and all crates contained in here are licensed under either of @@ -138,6 +159,8 @@ GStreamer itself is licensed under the Lesser General Public License version 2.1 or (at your option) any later version: https://www.gnu.org/licenses/lgpl-2.1.html + + ## Contribution Any kinds of contributions are welcome as a pull request. diff --git a/gstreamer-base/README.md b/gstreamer-base/README.md index 7ba542c39..079fb46ba 100644 --- a/gstreamer-base/README.md +++ b/gstreamer-base/README.md @@ -16,6 +16,17 @@ The API of the two is incompatible. A crate for writing GStreamer plugins in Rust can be found here: https://github.com/sdroege/gst-plugin-rs +## Table of Contents +1. [Installation](#installation) + 1. [Linux/BSDs](#installation-linux) + 1. [macOS](#installation-macos) + 1. [Windows](#installation-windows) +1. [Getting Started](#getting-started) +1. [License](#license) +1. [Contribution](#contribution) + + + ## Installation To build the GStreamer bindings or anything depending on them, you need to @@ -24,6 +35,8 @@ some of the examples/tutorials require various GStreamer plugins to be available, which can be found in gst-plugins-base, gst-plugins-good, gst-plugins-bad, gst-plugins-ugly and/or gst-libav. + + ### Linux/BSDs You need to install the above mentioned packages with your distributions @@ -41,6 +54,8 @@ $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \ Package names on other distributions should be similar. Please submit a pull request with instructions for yours. + + ### macOS You can install GStreamer and the plugins via [Homebrew](https://brew.sh/) or @@ -67,6 +82,8 @@ and set the `PKG_CONFIG_PATH` environment variable $ export PKG_CONFIG_PATH="/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}" ``` + + ### Windows You can install GStreamer and the plugins via [MSYS2](http://www.msys2.org/) @@ -96,6 +113,8 @@ and set the `PKG_CONFIG_PATH` environment variable $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}" ``` + + ## Getting Started The API reference can be found @@ -123,6 +142,8 @@ Rust can be found in the [examples](https://github.com/sdroege/gstreamer-rs/tree/master/examples) directory. + + ## LICENSE gstreamer-rs and all crates contained in here are licensed under either of @@ -138,6 +159,8 @@ GStreamer itself is licensed under the Lesser General Public License version 2.1 or (at your option) any later version: https://www.gnu.org/licenses/lgpl-2.1.html + + ## Contribution Any kinds of contributions are welcome as a pull request. diff --git a/gstreamer-player/README.md b/gstreamer-player/README.md index 3bec02f68..822133252 100644 --- a/gstreamer-player/README.md +++ b/gstreamer-player/README.md @@ -16,6 +16,17 @@ The API of the two is incompatible. A crate for writing GStreamer plugins in Rust can be found here: https://github.com/sdroege/gst-plugin-rs +## Table of Contents +1. [Installation](#installation) + 1. [Linux/BSDs](#installation-linux) + 1. [macOS](#installation-macos) + 1. [Windows](#installation-windows) +1. [Getting Started](#getting-started) +1. [License](#license) +1. [Contribution](#contribution) + + + ## Installation To build the GStreamer bindings or anything depending on them, you need to @@ -24,6 +35,8 @@ some of the examples/tutorials require various GStreamer plugins to be available, which can be found in gst-plugins-base, gst-plugins-good, gst-plugins-bad, gst-plugins-ugly and/or gst-libav. + + ### Linux/BSDs You need to install the above mentioned packages with your distributions @@ -41,6 +54,8 @@ $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \ Package names on other distributions should be similar. Please submit a pull request with instructions for yours. + + ### macOS You can install GStreamer and the plugins via [Homebrew](https://brew.sh/) or @@ -67,6 +82,8 @@ and set the `PKG_CONFIG_PATH` environment variable $ export PKG_CONFIG_PATH="/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}" ``` + + ### Windows You can install GStreamer and the plugins via [MSYS2](http://www.msys2.org/) @@ -96,6 +113,8 @@ and set the `PKG_CONFIG_PATH` environment variable $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}" ``` + + ## Getting Started The API reference can be found @@ -123,6 +142,8 @@ Rust can be found in the [examples](https://github.com/sdroege/gstreamer-rs/tree/master/examples) directory. + + ## LICENSE gstreamer-rs and all crates contained in here are licensed under either of @@ -138,6 +159,8 @@ GStreamer itself is licensed under the Lesser General Public License version 2.1 or (at your option) any later version: https://www.gnu.org/licenses/lgpl-2.1.html + + ## Contribution Any kinds of contributions are welcome as a pull request. diff --git a/gstreamer-video/README.md b/gstreamer-video/README.md index 9261cabe3..babdab467 100644 --- a/gstreamer-video/README.md +++ b/gstreamer-video/README.md @@ -16,6 +16,17 @@ The API of the two is incompatible. A crate for writing GStreamer plugins in Rust can be found here: https://github.com/sdroege/gst-plugin-rs +## Table of Contents +1. [Installation](#installation) + 1. [Linux/BSDs](#installation-linux) + 1. [macOS](#installation-macos) + 1. [Windows](#installation-windows) +1. [Getting Started](#getting-started) +1. [License](#license) +1. [Contribution](#contribution) + + + ## Installation To build the GStreamer bindings or anything depending on them, you need to @@ -24,6 +35,8 @@ some of the examples/tutorials require various GStreamer plugins to be available, which can be found in gst-plugins-base, gst-plugins-good, gst-plugins-bad, gst-plugins-ugly and/or gst-libav. + + ### Linux/BSDs You need to install the above mentioned packages with your distributions @@ -41,6 +54,8 @@ $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \ Package names on other distributions should be similar. Please submit a pull request with instructions for yours. + + ### macOS You can install GStreamer and the plugins via [Homebrew](https://brew.sh/) or @@ -67,6 +82,8 @@ and set the `PKG_CONFIG_PATH` environment variable $ export PKG_CONFIG_PATH="/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}" ``` + + ### Windows You can install GStreamer and the plugins via [MSYS2](http://www.msys2.org/) @@ -96,6 +113,8 @@ and set the `PKG_CONFIG_PATH` environment variable $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}" ``` + + ## Getting Started The API reference can be found @@ -123,6 +142,8 @@ Rust can be found in the [examples](https://github.com/sdroege/gstreamer-rs/tree/master/examples) directory. + + ## LICENSE gstreamer-rs and all crates contained in here are licensed under either of @@ -138,6 +159,8 @@ GStreamer itself is licensed under the Lesser General Public License version 2.1 or (at your option) any later version: https://www.gnu.org/licenses/lgpl-2.1.html + + ## Contribution Any kinds of contributions are welcome as a pull request. diff --git a/gstreamer/README.md b/gstreamer/README.md index cc4131cc6..0a6507573 100644 --- a/gstreamer/README.md +++ b/gstreamer/README.md @@ -16,6 +16,17 @@ The API of the two is incompatible. A crate for writing GStreamer plugins in Rust can be found here: https://github.com/sdroege/gst-plugin-rs +## Table of Contents +1. [Installation](#installation) + 1. [Linux/BSDs](#installation-linux) + 1. [macOS](#installation-macos) + 1. [Windows](#installation-windows) +1. [Getting Started](#getting-started) +1. [License](#license) +1. [Contribution](#contribution) + + + ## Installation To build the GStreamer bindings or anything depending on them, you need to @@ -24,6 +35,8 @@ some of the examples/tutorials require various GStreamer plugins to be available, which can be found in gst-plugins-base, gst-plugins-good, gst-plugins-bad, gst-plugins-ugly and/or gst-libav. + + ### Linux/BSDs You need to install the above mentioned packages with your distributions @@ -41,6 +54,8 @@ $ apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \ Package names on other distributions should be similar. Please submit a pull request with instructions for yours. + + ### macOS You can install GStreamer and the plugins via [Homebrew](https://brew.sh/) or @@ -67,6 +82,8 @@ and set the `PKG_CONFIG_PATH` environment variable $ export PKG_CONFIG_PATH="/Frameworks/GStreamer.framework/Versions/Current/lib/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}" ``` + + ### Windows You can install GStreamer and the plugins via [MSYS2](http://www.msys2.org/) @@ -96,6 +113,8 @@ and set the `PKG_CONFIG_PATH` environment variable $ export PKG_CONFIG_PATH="c:\\gstreamer\\1.0\\x86_64\\lib\\pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}" ``` + + ## Getting Started The API reference can be found @@ -123,6 +142,8 @@ Rust can be found in the [examples](https://github.com/sdroege/gstreamer-rs/tree/master/examples) directory. + + ## LICENSE gstreamer-rs and all crates contained in here are licensed under either of @@ -138,6 +159,8 @@ GStreamer itself is licensed under the Lesser General Public License version 2.1 or (at your option) any later version: https://www.gnu.org/licenses/lgpl-2.1.html + + ## Contribution Any kinds of contributions are welcome as a pull request.