hinoko-sys: add crate README.md

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

3 files changed, 38 insertions, 0 deletions

diff --git a/Cargo.toml b/Cargo.toml
index 7ee5056..6199af1 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -11,3 +11,11 @@ exclude = [
 default-members = [
     "hinoko",
 ]
+
+# For my convenience to generate README.md for each crates by my tool.
+[workspace.metadata.library.hinoko]
+repository = "https://github.com/takaswie/libhinoko"
+purpose = """
+operate Linux FireWire character device for isochronous packets and resources
+in IEEE 1394 bus.
+"""
diff --git a/hinoko-sys/README.md b/hinoko-sys/README.md
new file mode 100644
index 0000000..2919c4b
--- /dev/null
+++ b/hinoko-sys/README.md
@@ -0,0 +1,29 @@
+# hinoko-sys crate
+
+Rust FFI bindings and wrappers for [hinoko library](https://github.com/takaswie/libhinoko) to
+operate Linux FireWire character device for isochronous packets and resources
+in IEEE 1394 bus.
+
+The hinoko library version 0.7.1 is the minimum supported version for underlying library.
+
+The hinoko-sys crate is automatically generated by [gir tool](https://gtk-rs.org/gir/book/) provided
+by [gtk-rs project](https://gtk-rs.org/). Hinoko-0.0 file from hinoko library is used for the
+generation.
+
+## License
+
+The hinoko-sys crate is released under [MIT license](https://spdx.org/licenses/MIT.html).
+
+## Dependency
+
+The hinoko-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 hinoko-sys crate is maintained by Takashi Sakamoto.
+The remote repository is located in <https://github.com/takaswie/hinoko-rs/>.
+
+## Support
+
+If finding issue, please file it in <https://github.com/takaswie/hinoko-rs/>.
diff --git a/hinoko-sys/src/lib.rs b/hinoko-sys/src/lib.rs
index 83f2fa9..489e843 100644
--- a/hinoko-sys/src/lib.rs
+++ b/hinoko-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,