From a30582a1ef9a84b0e36f74c90e9f41f0c7f8670a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebastian=20Dr=C3=B6ge?= Date: Fri, 1 Sep 2017 12:05:04 +0300 Subject: [PATCH] Add README.md to all crate subdirectories This way it would show up on crates.io --- README.md | 2 +- gstreamer-app/Cargo.toml | 1 + gstreamer-app/README.md | 40 +++++++++++++++++++++++++++++++++++++ gstreamer-audio/Cargo.toml | 1 + gstreamer-audio/README.md | 40 +++++++++++++++++++++++++++++++++++++ gstreamer-player/Cargo.toml | 1 + gstreamer-player/README.md | 40 +++++++++++++++++++++++++++++++++++++ gstreamer-video/Cargo.toml | 1 + gstreamer-video/README.md | 40 +++++++++++++++++++++++++++++++++++++ gstreamer/Cargo.toml | 1 + gstreamer/README.md | 40 +++++++++++++++++++++++++++++++++++++ 11 files changed, 206 insertions(+), 1 deletion(-) create mode 100644 gstreamer-app/README.md create mode 100644 gstreamer-audio/README.md create mode 100644 gstreamer-player/README.md create mode 100644 gstreamer-video/README.md create mode 100644 gstreamer/README.md diff --git a/README.md b/README.md index 9d7f99e74..e9bcd4dbb 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# gstreamer-rs [![Build Status](https://travis-ci.org/sdroege/gstreamer-rs.svg?branch=master)](https://travis-ci.org/sdroege/gstreamer-rs) +# gstreamer-rs [![crates.io](https://img.shields.io/crates/v/gstreamer.svg)](https://crates.io/crates/gstreamer) [![Build Status](https://travis-ci.org/sdroege/gstreamer-rs.svg?branch=master)](https://travis-ci.org/sdroege/gstreamer-rs) [GStreamer](https://gstreamer.freedesktop.org/) bindings for Rust. Documentation can be found [here](https://sdroege.github.io/rustdoc/gstreamer/gstreamer/). diff --git a/gstreamer-app/Cargo.toml b/gstreamer-app/Cargo.toml index baf2be9e2..cc025dd67 100644 --- a/gstreamer-app/Cargo.toml +++ b/gstreamer-app/Cargo.toml @@ -6,6 +6,7 @@ categories = ["api-bindings", "multimedia"] description = "Rust bindings for GStreamer App library" repository = "https://github.com/sdroege/gstreamer-rs" license = "MIT/Apache-2.0" +readme = "README.md" homepage = "https://gstreamer.freedesktop.org" documentation = "https://sdroege.github.io/rustdoc/gstreamer/gstreamer-app" keywords = ["gstreamer", "multimedia", "audio", "video", "gnome"] diff --git a/gstreamer-app/README.md b/gstreamer-app/README.md new file mode 100644 index 000000000..abd9b8471 --- /dev/null +++ b/gstreamer-app/README.md @@ -0,0 +1,40 @@ +# gstreamer-rs [![crates.io](https://img.shields.io/crates/v/gstreamer-app.svg)](https://crates.io/crates/gstreamer-app) [![Build Status](https://travis-ci.org/sdroege/gstreamer-rs.svg?branch=master)](https://travis-ci.org/sdroege/gstreamer-rs) + +[GStreamer](https://gstreamer.freedesktop.org/) (App library) bindings for Rust. +Documentation can be found [here](https://sdroege.github.io/rustdoc/gstreamer/gstreamer/). + +These bindings are providing a safe API that can be used to interface with +GStreamer, e.g. for writing GStreamer-based applications. + +For background and motivation, see the [announcement blogpost](https://coaxion.net/blog/2017/07/writing-gstreamer-applications-in-rust/). + +The bindings (since 0.8.0) are autogenerated with [gir](https://github.com/gtk-rs/gir/) +based on the [GObject-Introspection](https://wiki.gnome.org/Projects/GObjectIntrospection/) +API metadata provided by the GStreamer project. Older versions before 0.8.0 were manually +written and the repository can be found [here](https://github.com/arturoc/gstreamer1.0-rs). +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 + +## LICENSE + +gstreamer-rs and all crates contained in here are licensed under either of + + * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or + http://www.apache.org/licenses/LICENSE-2.0) + * MIT license ([LICENSE-MIT](LICENSE-MIT) or + http://opensource.org/licenses/MIT) + +at your option. + +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. + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in gstreamer-rs by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. diff --git a/gstreamer-audio/Cargo.toml b/gstreamer-audio/Cargo.toml index 2f180b80b..ea255b733 100644 --- a/gstreamer-audio/Cargo.toml +++ b/gstreamer-audio/Cargo.toml @@ -6,6 +6,7 @@ categories = ["api-bindings", "multimedia"] description = "Rust bindings for GStreamer Audio library" repository = "https://github.com/sdroege/gstreamer-rs" license = "MIT/Apache-2.0" +readme = "README.md" homepage = "https://gstreamer.freedesktop.org" documentation = "https://sdroege.github.io/rustdoc/gstreamer/gstreamer-audio" keywords = ["gstreamer", "multimedia", "audio", "video", "gnome"] diff --git a/gstreamer-audio/README.md b/gstreamer-audio/README.md new file mode 100644 index 000000000..167e848e3 --- /dev/null +++ b/gstreamer-audio/README.md @@ -0,0 +1,40 @@ +# gstreamer-rs [![crates.io](https://img.shields.io/crates/v/gstreamer-audio.svg)](https://crates.io/crates/gstreamer-audio) [![Build Status](https://travis-ci.org/sdroege/gstreamer-rs.svg?branch=master)](https://travis-ci.org/sdroege/gstreamer-rs) + +[GStreamer](https://gstreamer.freedesktop.org/) (Audio library) bindings for Rust. +Documentation can be found [here](https://sdroege.github.io/rustdoc/gstreamer/gstreamer/). + +These bindings are providing a safe API that can be used to interface with +GStreamer, e.g. for writing GStreamer-based applications. + +For background and motivation, see the [announcement blogpost](https://coaxion.net/blog/2017/07/writing-gstreamer-applications-in-rust/). + +The bindings (since 0.8.0) are autogenerated with [gir](https://github.com/gtk-rs/gir/) +based on the [GObject-Introspection](https://wiki.gnome.org/Projects/GObjectIntrospection/) +API metadata provided by the GStreamer project. Older versions before 0.8.0 were manually +written and the repository can be found [here](https://github.com/arturoc/gstreamer1.0-rs). +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 + +## LICENSE + +gstreamer-rs and all crates contained in here are licensed under either of + + * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or + http://www.apache.org/licenses/LICENSE-2.0) + * MIT license ([LICENSE-MIT](LICENSE-MIT) or + http://opensource.org/licenses/MIT) + +at your option. + +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. + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in gstreamer-rs by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. diff --git a/gstreamer-player/Cargo.toml b/gstreamer-player/Cargo.toml index 71a3ed419..971ad0c75 100644 --- a/gstreamer-player/Cargo.toml +++ b/gstreamer-player/Cargo.toml @@ -6,6 +6,7 @@ categories = ["api-bindings", "multimedia"] description = "Rust bindings for GStreamer Player library" repository = "https://github.com/sdroege/gstreamer-rs" license = "MIT/Apache-2.0" +readme = "README.md" homepage = "https://gstreamer.freedesktop.org" documentation = "https://sdroege.github.io/rustdoc/gstreamer/gstreamer-player" keywords = ["gstreamer", "multimedia", "audio", "video", "gnome"] diff --git a/gstreamer-player/README.md b/gstreamer-player/README.md new file mode 100644 index 000000000..b1f9d377b --- /dev/null +++ b/gstreamer-player/README.md @@ -0,0 +1,40 @@ +# gstreamer-rs [![crates.io](https://img.shields.io/crates/v/gstreamer-player.svg)](https://crates.io/crates/gstreamer-player) [![Build Status](https://travis-ci.org/sdroege/gstreamer-rs.svg?branch=master)](https://travis-ci.org/sdroege/gstreamer-rs) + +[GStreamer](https://gstreamer.freedesktop.org/) (Player library) bindings for Rust. +Documentation can be found [here](https://sdroege.github.io/rustdoc/gstreamer/gstreamer/). + +These bindings are providing a safe API that can be used to interface with +GStreamer, e.g. for writing GStreamer-based applications. + +For background and motivation, see the [announcement blogpost](https://coaxion.net/blog/2017/07/writing-gstreamer-applications-in-rust/). + +The bindings (since 0.8.0) are autogenerated with [gir](https://github.com/gtk-rs/gir/) +based on the [GObject-Introspection](https://wiki.gnome.org/Projects/GObjectIntrospection/) +API metadata provided by the GStreamer project. Older versions before 0.8.0 were manually +written and the repository can be found [here](https://github.com/arturoc/gstreamer1.0-rs). +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 + +## LICENSE + +gstreamer-rs and all crates contained in here are licensed under either of + + * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or + http://www.apache.org/licenses/LICENSE-2.0) + * MIT license ([LICENSE-MIT](LICENSE-MIT) or + http://opensource.org/licenses/MIT) + +at your option. + +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. + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in gstreamer-rs by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. diff --git a/gstreamer-video/Cargo.toml b/gstreamer-video/Cargo.toml index 4b2c4b0db..2ba54c27e 100644 --- a/gstreamer-video/Cargo.toml +++ b/gstreamer-video/Cargo.toml @@ -6,6 +6,7 @@ categories = ["api-bindings", "multimedia"] description = "Rust bindings for GStreamer Video library" repository = "https://github.com/sdroege/gstreamer-rs" license = "MIT/Apache-2.0" +readme = "README.md" homepage = "https://gstreamer.freedesktop.org" documentation = "https://sdroege.github.io/rustdoc/gstreamer/gstreamer-video" keywords = ["gstreamer", "multimedia", "audio", "video", "gnome"] diff --git a/gstreamer-video/README.md b/gstreamer-video/README.md new file mode 100644 index 000000000..2ef4aabe4 --- /dev/null +++ b/gstreamer-video/README.md @@ -0,0 +1,40 @@ +# gstreamer-rs [![crates.io](https://img.shields.io/crates/v/gstreamer-video.svg)](https://crates.io/crates/gstreamer-video) [![Build Status](https://travis-ci.org/sdroege/gstreamer-rs.svg?branch=master)](https://travis-ci.org/sdroege/gstreamer-rs) + +[GStreamer](https://gstreamer.freedesktop.org/) (Video library) bindings for Rust. +Documentation can be found [here](https://sdroege.github.io/rustdoc/gstreamer/gstreamer/). + +These bindings are providing a safe API that can be used to interface with +GStreamer, e.g. for writing GStreamer-based applications. + +For background and motivation, see the [announcement blogpost](https://coaxion.net/blog/2017/07/writing-gstreamer-applications-in-rust/). + +The bindings (since 0.8.0) are autogenerated with [gir](https://github.com/gtk-rs/gir/) +based on the [GObject-Introspection](https://wiki.gnome.org/Projects/GObjectIntrospection/) +API metadata provided by the GStreamer project. Older versions before 0.8.0 were manually +written and the repository can be found [here](https://github.com/arturoc/gstreamer1.0-rs). +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 + +## LICENSE + +gstreamer-rs and all crates contained in here are licensed under either of + + * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or + http://www.apache.org/licenses/LICENSE-2.0) + * MIT license ([LICENSE-MIT](LICENSE-MIT) or + http://opensource.org/licenses/MIT) + +at your option. + +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. + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in gstreamer-rs by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. diff --git a/gstreamer/Cargo.toml b/gstreamer/Cargo.toml index 04ecd9965..43101bb25 100644 --- a/gstreamer/Cargo.toml +++ b/gstreamer/Cargo.toml @@ -6,6 +6,7 @@ categories = ["api-bindings", "multimedia"] description = "Rust bindings for GStreamer" repository = "https://github.com/sdroege/gstreamer-rs" license = "MIT/Apache-2.0" +readme = "README.md" homepage = "https://gstreamer.freedesktop.org" documentation = "https://sdroege.github.io/rustdoc/gstreamer/gstreamer" keywords = ["gstreamer", "multimedia", "audio", "video", "gnome"] diff --git a/gstreamer/README.md b/gstreamer/README.md new file mode 100644 index 000000000..e9bcd4dbb --- /dev/null +++ b/gstreamer/README.md @@ -0,0 +1,40 @@ +# gstreamer-rs [![crates.io](https://img.shields.io/crates/v/gstreamer.svg)](https://crates.io/crates/gstreamer) [![Build Status](https://travis-ci.org/sdroege/gstreamer-rs.svg?branch=master)](https://travis-ci.org/sdroege/gstreamer-rs) + +[GStreamer](https://gstreamer.freedesktop.org/) bindings for Rust. +Documentation can be found [here](https://sdroege.github.io/rustdoc/gstreamer/gstreamer/). + +These bindings are providing a safe API that can be used to interface with +GStreamer, e.g. for writing GStreamer-based applications. + +For background and motivation, see the [announcement blogpost](https://coaxion.net/blog/2017/07/writing-gstreamer-applications-in-rust/). + +The bindings (since 0.8.0) are autogenerated with [gir](https://github.com/gtk-rs/gir/) +based on the [GObject-Introspection](https://wiki.gnome.org/Projects/GObjectIntrospection/) +API metadata provided by the GStreamer project. Older versions before 0.8.0 were manually +written and the repository can be found [here](https://github.com/arturoc/gstreamer1.0-rs). +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 + +## LICENSE + +gstreamer-rs and all crates contained in here are licensed under either of + + * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or + http://www.apache.org/licenses/LICENSE-2.0) + * MIT license ([LICENSE-MIT](LICENSE-MIT) or + http://opensource.org/licenses/MIT) + +at your option. + +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. + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in gstreamer-rs by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions.