M5Utility/README.md

# M5Utility

## Overview
This library is a collection of common functionality for other M5Libraries and products.

## UnitTest (For internal maintainers)
UnitTest is included, which can run on PlatformIO.

## Doxygen document

[GitHub Pages](https://m5stack.github.io/M5Utility/)

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
- [Doxygen](https://www.doxygen.nl/)
- [pcregrep](https://formulae.brew.sh/formula/pcre2)
- [Git](https://git-scm.com/) (Output commit hash to html)


---

## 概要
このライブラリは M5Stack 関連ライブラリのための共通ライブラリです。

## ユニットテスト(メンテナンス用)
googleTest によるユニットテストを内包しています。 PlatformIO で実行できます。


## Doxygen ドキュメント
[GitHub Pages](https://m5stack.github.io/M5Utility/)

あなたのローカルマシンでドキュメントを生成したい場合は、以下のコマンドを実行してください。
```
bash docs/doxy.sh
```
docs/html の下に出力されます。  
Git コミットのハッシュを html に出力したい場合は、 git クローンしたフォルダに対して実行してください。

### 必要な物
- [Doxygen](https://www.doxygen.nl/)
- [pcregrep](https://formulae.brew.sh/formula/pcre2)
- [Git](https://git-scm.com/)