hinawa-sys: add crate README

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

4 files changed, 40 insertions, 0 deletions

diff --git a/Cargo.toml b/Cargo.toml
index a9015de..fa21027 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -11,3 +11,11 @@ exclude = [
 default-members = [
     "hinawa",
 ]
+
+# For my convenience to generate README.md for each crates by my tool.
+[workspace.metadata.library.hinawa]
+repository = "https://github.com/alsa-project/libhinawa"
+purpose = """
+operate Linux FireWire character device for asynchronous packet and topology generation
+in IEEE 1394 bus
+"""
diff --git a/hinawa-sys/Cargo.toml b/hinawa-sys/Cargo.toml
index f683bdf..87e4116 100644
--- a/hinawa-sys/Cargo.toml
+++ b/hinawa-sys/Cargo.toml
@@ -13,6 +13,7 @@ exclude = ["Gir.toml"]
 homepage = "https://alsa-project.github.io/gobject-introspection-docs/"
 keywords = ["ieee1394", "firewire", "linux", "glib", "ffi"]
 license = "MIT"
+readme = "README.md"
 repository = "https://github.com/alsa-project/hinawa-rs/"
 [package.metadata.docs.rs]
 features = ["dox"]
diff --git a/hinawa-sys/README.md b/hinawa-sys/README.md
new file mode 100644
index 0000000..88dcf93
--- /dev/null
+++ b/hinawa-sys/README.md
@@ -0,0 +1,30 @@
+# hinawa-sys crate
+
+Rust FFI bindings and wrappers for [hinawa library](https://github.com/alsa-project/libhinawa) to
+operate Linux FireWire character device for asynchronous packet and topology generation
+in IEEE 1394 bus.
+
+The hinawa library version 2.5 is the minimum supported version for underlying library.
+
+The hinawa-sys crate is automatically generated by [gir tool](https://gtk-rs.org/gir/book/) provided
+by [gtk-rs project](https://gtk-rs.org/). Hinawa-3.0 file from hinawa library is used for the
+generation.
+
+## License
+
+The hinawa-sys crate is released under [MIT license](https://spdx.org/licenses/MIT.html).
+
+## Dependency
+
+The hinawa-sys crate depends on FFI crates provided by [gtk-rs project](https://gtk-rs.org/) for
+type/object system, event loop, and dispacher.
+
+## Repository
+
+The hinawa-sys crate is the part of ALSA project and maintained by
+[ALSA gobject-introspection team](https://alsa-project.github.io/gobject-introspection-docs/).
+The remote repository is located in <https://github.com/alsa-project/hinawa-rs/>.
+
+## Support
+
+If finding issue, please file it in <https://github.com/alsa-project/hinawa-rs/>.
diff --git a/hinawa-sys/src/lib.rs b/hinawa-sys/src/lib.rs
index 2bb7bb5..52327d0 100644
--- a/hinawa-sys/src/lib.rs
+++ b/hinawa-sys/src/lib.rs
@@ -3,6 +3,7 @@
 // from gir-files (https://github.com/gtk-rs/gir-files)
 // DO NOT EDIT
 
+#![doc = include_str!("../README.md")]
 #![allow(non_camel_case_types, non_upper_case_globals, non_snake_case)]
 #![allow(
     clippy::approx_constant,