From: Erik Schilling <erik.schilling@linaro.org>
To: Linux-GPIO <linux-gpio@vger.kernel.org>
Cc: Viresh Kumar <viresh.kumar@linaro.org>,
Erik Schilling <erik.schilling@linaro.org>
Subject: [libgpiod][PATCH 1/2] bindings: rust: add README.md for libgpiod crate
Date: Fri, 30 Jun 2023 12:46:43 +0200 [thread overview]
Message-ID: <20230630-rust-readme-v1-1-1ce9e6f7985c@linaro.org> (raw)
In-Reply-To: <20230630-rust-readme-v1-0-1ce9e6f7985c@linaro.org>
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
+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.41.0
next prev parent reply other threads:[~2023-06-30 10:47 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-06-30 10:46 [libgpiod][PATCH 0/2] bindings: rust: add README for crates.io Erik Schilling
2023-06-30 10:46 ` Erik Schilling [this message]
2023-07-03 4:21 ` [libgpiod][PATCH 1/2] bindings: rust: add README.md for libgpiod crate Viresh Kumar
2023-06-30 10:46 ` [libgpiod][PATCH 2/2] bindings: rust: mention the libgpiod crate from libgpiod-sys Erik Schilling
2023-07-03 4:22 ` Viresh Kumar
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230630-rust-readme-v1-1-1ce9e6f7985c@linaro.org \
--to=erik.schilling@linaro.org \
--cc=linux-gpio@vger.kernel.org \
--cc=viresh.kumar@linaro.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).