| Message ID | 20230630-rust-readme-v1-1-1ce9e6f7985c@linaro.org |
|---|---|
| State | New |
| Headers | show |
| Series | [libgpiod,1/2] bindings: rust: add README.md for libgpiod crate | expand |
On 30-06-23, 12:46, Erik Schilling wrote: > 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 <erik.schilling@linaro.org> > --- > bindings/rust/libgpiod/README.md | 25 +++++++++++++++++++++++++ > 1 file changed, 25 insertions(+) > > diff --git a/bindings/rust/libgpiod/README.md b/bindings/rust/libgpiod/README.md > new file mode 100644 > index 0000000..4afd3d4 > --- /dev/null > +++ b/bindings/rust/libgpiod/README.md > @@ -0,0 +1,25 @@ > +<!-- > +SPDX-License-Identifier: CC0-1.0 > +SPDX-FileCopyrightText: 2023 Linaro Ltd. > +SPDX-FileCopyrightText: 2023 Erik Schilling <erik.schilling@linaro.org> > +--> > + > +# 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 provides an easy to use abstraction over the Linux GPIO character ^ that ? > +driver. This crate builds on top of `libgpiod-sys` and exports a safe interface > +to the C library.
diff --git a/bindings/rust/libgpiod/README.md b/bindings/rust/libgpiod/README.md new file mode 100644 index 0000000..4afd3d4 --- /dev/null +++ b/bindings/rust/libgpiod/README.md @@ -0,0 +1,25 @@ +<!-- +SPDX-License-Identifier: CC0-1.0 +SPDX-FileCopyrightText: 2023 Linaro Ltd. +SPDX-FileCopyrightText: 2023 Erik Schilling <erik.schilling@linaro.org> +--> + +# 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 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)
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 <erik.schilling@linaro.org> --- bindings/rust/libgpiod/README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+)