From 1cfdac3a6fc2fc89d1117219f55c1ac76c6327a9 Mon Sep 17 00:00:00 2001
From: GOB <goblin52@gmail.com>
Date: Wed, 18 Sep 2024 14:35:00 +0900
Subject: [PATCH] Add about doxygen

---
 README.ja.md | 13 +++++++++++++
 README.md    | 16 ++++++++++++++++
 2 files changed, 29 insertions(+)

diff --git a/README.ja.md b/README.ja.md
index b8f67a9..14ec50f 100644
--- a/README.ja.md
+++ b/README.ja.md
@@ -137,3 +137,16 @@ GPIO、UART は将来対応予定です。
 
 他のユニットは開発、確認後追加されます。
 
+## Doxygen ドキュメント
+あなたのローカルマシンでドキュメントを生成したい場合は、以下のコマンドを実行してください。
+```
+bash docs/doxy.sh
+```
+docs/html の下に出力されます。  
+Git コミットのハッシュを html に出力したい場合は、 git クローンしたフォルダに対して実行してください。
+
+### 必要な物
+- [Doxyegn](https://www.doxygen.nl/)
+- [pcregrep](https://formulae.brew.sh/formula/pcre2)
+- [Git](https://git-scm.com/)
+
diff --git a/README.md b/README.md
index e5d0aa0..0063dcb 100644
--- a/README.md
+++ b/README.md
@@ -137,3 +137,19 @@ Other devices will be added after confirmation of operation.
 
 Other units will be added after they are developed and tested.
 
+
+## Doxygen document
+If you want to generate documents on your local machine, execute the following command
+
+```
+bash docs/doxy.sh
+```
+
+It will output it under docs/html  
+If you want to output Git commit hashes to html, do it for the git cloned folder.
+
+### Required
+- [Doxyegn](https://www.doxygen.nl/)
+- [pcregrep](https://formulae.brew.sh/formula/pcre2)
+- [Git](https://git-scm.com/) (Output commit hash to html)
+