Skip to content

Commit

Permalink
Add about doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
GOB52 committed Sep 18, 2024
1 parent a75984a commit 1cfdac3
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)

16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit 1cfdac3

Please sign in to comment.