From 3f6e0bfbee2c39821f80eb4bf8c44fd29392a1c3 Mon Sep 17 00:00:00 2001 From: Erik Schilling Date: Mon, 3 Jul 2023 09:19:59 +0200 Subject: [PATCH] bindings: rust: add README.md for libgpiod crate crates.io treats the README as landing page for a crate [1]. Since we have none, it currently displays a blank page. Lets add at least a little bit of info here so people can figure out what they are dealing with. [1] https://crates.io/crates/libgpiod Signed-off-by: Erik Schilling Acked-by: Viresh Kumar Signed-off-by: Bartosz Golaszewski --- bindings/rust/libgpiod/README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 bindings/rust/libgpiod/README.md diff --git a/bindings/rust/libgpiod/README.md b/bindings/rust/libgpiod/README.md new file mode 100644 index 0000000..8d514e7 --- /dev/null +++ b/bindings/rust/libgpiod/README.md @@ -0,0 +1,25 @@ + + +# Safe wrapper around Rust FFI bindings for libgpiod + +[libgpiod](https://git.kernel.org/pub/scm/libs/libgpiod/libgpiod.git/tree/README) +is a C library that provides an easy to use abstraction over the Linux GPIO +character driver. This crate builds on top of `libgpiod-sys` and exports a safe +interface to the C library. + +## Build requirements + +By default, `libgpiod-sys` builds against the libgpiod version identified via +`pkg-config`. See the `README.md` of `libgpiod-sys` for options to override +that. + +## License + +This project is licensed under either of + +- [Apache License](http://www.apache.org/licenses/LICENSE-2.0), Version 2.0 +- [BSD-3-Clause License](https://opensource.org/licenses/BSD-3-Clause) -- 2.30.2