aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTakashi Sakamoto <o-takashi@sakamocchi.jp>2023-08-12 12:20:24 +0900
committerTakashi Sakamoto <o-takashi@sakamocchi.jp>2023-10-11 20:59:57 +0900
commit0704dd5bb1ad9cf2227e399da4ec6269d2679193 (patch)
tree59fb07d5608b3d24b9253c88527602ecd38a1942
parentb02f432309627b4ce5854d95b680586cd9c8879d (diff)
downloadlibhinawa-0704dd5bb1ad9cf2227e399da4ec6269d2679193.tar.gz
add description about Hinawa to README
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
-rw-r--r--README.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 8a68a6a..bb3d71b 100644
--- a/README.rst
+++ b/README.rst
@@ -219,3 +219,19 @@ The version 3 library is specifically tailored to features in Linux FireWire sub
sole focus on asynchronous communication in IEEE 1394 bus. For isochronous communication,
`libhinoko <https://git.kernel.org/pub/scm/libs/ieee1394/libhinoko.git/>`_ provides the
necessary features.
+
+About Hinawa
+============
+
+``Hinawa`` is a Japanese term for a match cord used to ignite fires for various purposes. For
+example, twine fuses used for igniting gunpowder weapons are a type of ``Hinawa``. The name
+``Hinawa`` consists of two kanji characters; ``Hi`` (U+2F55 |kanji-hi|) meaning ``fire``, and
+``Nawa`` (U+7E04 |kanji-nawa|) meaning ``cord``.
+
+.. |kanji-hi| unicode:: &#x2f55 .. Hi spelled in Kanji
+.. |kanji-nawa| unicode:: &#x7e04 .. Nawa spelled in Kanji
+
+In the IEEE 1394 bus, asynchronous communication is the foundational step for operating functions
+within nodes. The ``Hinawa`` library is designed specifically to address this aspect.
+
+end