diff options
| author | Sebastian Dröge <sebastian@centricular.com> | 2021-06-29 00:23:09 +0300 |
|---|---|---|
| committer | Sebastian Dröge <sebastian@centricular.com> | 2021-06-29 00:23:09 +0300 |
| commit | b5375d2f216c22cf576f434fe88629b4cd4cb079 (patch) | |
| tree | cadbdeda6b445e5a1c9e4f4492f532567b4c9561 /version-helper | |
| parent | 23219c3c09f2a6a6d3c29d8bc68033bac7f8c0f7 (diff) | |
gst-plugin-version-helper: Add README.md and fix up docs
Diffstat (limited to 'version-helper')
| -rw-r--r-- | version-helper/README.md | 40 | ||||
| -rw-r--r-- | version-helper/src/lib.rs | 2 |
2 files changed, 41 insertions, 1 deletions
diff --git a/version-helper/README.md b/version-helper/README.md new file mode 100644 index 000000000..07a23e3ff --- /dev/null +++ b/version-helper/README.md @@ -0,0 +1,40 @@ +# gst-plugin-version-helper [](https://crates.io/crates/gst-plugin-version-helper) [](https://docs.rs/gst-plugin-version-helper) + +Extracts release for [GStreamer](https://gstreamer.freedesktop.org) plugin metadata + +See the [documentation](https://docs.rs/gst-plugin-version-helper) for details. + +This function is supposed to be used as follows in the `build.rs` of a crate that implements a +plugin: + +```rust,ignore +gst_plugin_version_helper::get_info(); +``` + +Inside `lib.rs` of the plugin, the information provided by `get_info` are usable as follows: + +```rust,ignore +gst::plugin_define!( + the_plugin_name, + env!("CARGO_PKG_DESCRIPTION"), + plugin_init, + concat!(env!("CARGO_PKG_VERSION"), "-", env!("COMMIT_ID")), + "The Plugin's License", + env!("CARGO_PKG_NAME"), + env!("CARGO_PKG_NAME"), + env!("CARGO_PKG_REPOSITORY"), + env!("BUILD_REL_DATE") +); + +## LICENSE + +`gst-plugin-version-helper` is licensed under the MIT license ([LICENSE](LICENSE) or +http://opensource.org/licenses/MIT). + +## 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-version-helper` by you shall be licensed +under the MIT license as above, without any additional terms or conditions. diff --git a/version-helper/src/lib.rs b/version-helper/src/lib.rs index 7841c5372..0258b10e3 100644 --- a/version-helper/src/lib.rs +++ b/version-helper/src/lib.rs @@ -17,7 +17,7 @@ //! Inside `lib.rs` of the plugin, the information provided by `get_info` are usable as follows: //! //! ```rust,ignore -//! plugin_define!( +//! gst::plugin_define!( //! the_plugin_name, //! env!("CARGO_PKG_DESCRIPTION"), //! plugin_init, |