mirror of
https://gitlab.freedesktop.org/gstreamer/gst-plugins-rs.git
synced 2024-10-31 22:58:51 +00:00
Update README.md and include it in the gst-plugin crate too
This commit is contained in:
parent
723409e05a
commit
2decd553d7
2 changed files with 73 additions and 4 deletions
25
README.md
25
README.md
|
@ -1,10 +1,27 @@
|
|||
# gst-plugin-rs [![Build Status](https://travis-ci.org/sdroege/gst-plugin-rs.svg?branch=master)](https://travis-ci.org/sdroege/gst-plugin-rs)
|
||||
# gst-plugin-rs [![crates.io](https://img.shields.io/crates/v/gst-plugin.svg)](https://crates.io/crates/gst-plugin) [![Build Status](https://travis-ci.org/sdroege/gst-plugin-rs.svg?branch=master)](https://travis-ci.org/sdroege/gst-plugin-rs)
|
||||
|
||||
[GStreamer](https://gstreamer.freedesktop.org/) elements built in the [Rust programming language](https://www.rust-lang.org/).
|
||||
Infrastructure for writing [GStreamer](https://gstreamer.freedesktop.org/)
|
||||
plugins and elements in the [Rust programming
|
||||
language](https://www.rust-lang.org/), and a collection of various GStreamer
|
||||
plugins.
|
||||
|
||||
For background and motivation, see the [announcement blogpost](https://coaxion.net/blog/2016/05/writing-gstreamer-plugins-and-elements-in-rust/) and the follow-up blogposts [1](https://coaxion.net/blog/2016/09/writing-gstreamer-elements-in-rust-part-2-dont-panic-we-have-better-assertions-now-and-other-updates/), [2](https://coaxion.net/blog/2016/11/writing-gstreamer-elements-in-rust-part-3-parsing-data-from-untrusted-sources-like-its-2016/), [3](https://coaxion.net/blog/2017/03/writing-gstreamer-elements-in-rust-part-4-logging-cows-and-plugins/).
|
||||
Documentation for the crate containing the infrastructure for writing
|
||||
GStreamer plugins in Rust, [`gst-plugin`](gst-plugin), can be found
|
||||
[here](https://sdroege.github.io/rustdoc/gst-plugin/gst_plugin/). The whole
|
||||
API builds upon the [application-side GStreamer bindings](https://github.com/sdroege/gstreamer-rs).
|
||||
Check the README.md of that repository also for details about how to set-up
|
||||
your development environment.
|
||||
|
||||
Application-side bindings for GStreamer can be found here: https://github.com/sdroege/gstreamer-rs
|
||||
Various example plugins can be found in the [GIT repository](https://github.com/sdroege/gst-plugin-rs/).
|
||||
|
||||
For background and motivation, see the [announcement
|
||||
blogpost](https://coaxion.net/blog/2016/05/writing-gstreamer-plugins-and-elements-in-rust/)
|
||||
and the follow-up blogposts
|
||||
[1](https://coaxion.net/blog/2016/09/writing-gstreamer-elements-in-rust-part-2-dont-panic-we-have-better-assertions-now-and-other-updates/),
|
||||
[2](https://coaxion.net/blog/2016/11/writing-gstreamer-elements-in-rust-part-3-parsing-data-from-untrusted-sources-like-its-2016/),
|
||||
[3](https://coaxion.net/blog/2017/03/writing-gstreamer-elements-in-rust-part-4-logging-cows-and-plugins/).
|
||||
Note that the overall implementation has changed completely since those
|
||||
blogposts were written.
|
||||
|
||||
## LICENSE
|
||||
|
||||
|
|
52
gst-plugin/README.md
Normal file
52
gst-plugin/README.md
Normal file
|
@ -0,0 +1,52 @@
|
|||
# gst-plugin-rs [![crates.io](https://img.shields.io/crates/v/gst-plugin.svg)](https://crates.io/crates/gst-plugin) [![Build Status](https://travis-ci.org/sdroege/gst-plugin-rs.svg?branch=master)](https://travis-ci.org/sdroege/gst-plugin-rs)
|
||||
|
||||
Infrastructure for writing [GStreamer](https://gstreamer.freedesktop.org/)
|
||||
plugins and elements in the [Rust programming
|
||||
language](https://www.rust-lang.org/), and a collection of various GStreamer
|
||||
plugins.
|
||||
|
||||
Documentation for the crate containing the infrastructure for writing
|
||||
GStreamer plugins in Rust, [`gst-plugin`](gst-plugin), can be found
|
||||
[here](https://sdroege.github.io/rustdoc/gst-plugin/gst_plugin/). The whole
|
||||
API builds upon the [application-side GStreamer bindings](https://github.com/sdroege/gstreamer-rs).
|
||||
Check the README.md of that repository also for details about how to set-up
|
||||
your development environment.
|
||||
|
||||
Various example plugins can be found in the [GIT repository](https://github.com/sdroege/gst-plugin-rs/).
|
||||
|
||||
For background and motivation, see the [announcement
|
||||
blogpost](https://coaxion.net/blog/2016/05/writing-gstreamer-plugins-and-elements-in-rust/)
|
||||
and the follow-up blogposts
|
||||
[1](https://coaxion.net/blog/2016/09/writing-gstreamer-elements-in-rust-part-2-dont-panic-we-have-better-assertions-now-and-other-updates/),
|
||||
[2](https://coaxion.net/blog/2016/11/writing-gstreamer-elements-in-rust-part-3-parsing-data-from-untrusted-sources-like-its-2016/),
|
||||
[3](https://coaxion.net/blog/2017/03/writing-gstreamer-elements-in-rust-part-4-logging-cows-and-plugins/).
|
||||
Note that the overall implementation has changed completely since those
|
||||
blogposts were written.
|
||||
|
||||
## LICENSE
|
||||
|
||||
gst-plugin-rs and all crates contained in here that are not listed below 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.
|
||||
|
||||
gst-plugin-togglerecord is licensed under the Lesser General Public License
|
||||
([LICENSE-LGPLv2](LICENSE-LGPLv2)) version 2.1 or (at your option) any later
|
||||
version.
|
||||
|
||||
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 gst-plugin-rs by you, as defined in the Apache-2.0 license, shall be
|
||||
dual licensed as above, without any additional terms or conditions.
|
Loading…
Reference in a new issue