m5/M5Utility
0
0
Fork 0
mirror of https://github.com/m5stack/M5Utility.git synced 2026-05-20 11:27:29 -07:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
GOB
2024-08-08 23:37:48 +09:00
parent a3cd841cb4
commit e2a4eab158
1 changed files with 15 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+15 -3
View File
@@ -6,7 +6,19 @@ This library is a collection of common functionality for other M5Libraries and p
## UnitTest (For internal maintainers)
UnitTest is included, which can run on PlatformIO.
### Required Libraries for UnitTest
- M5Unified
- googleTest@1.12.1
## 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)