From e2a4eab158fa86fa1bbd7d65fdebae38f89df2ea Mon Sep 17 00:00:00 2001 From: GOB Date: Thu, 8 Aug 2024 23:37:48 +0900 Subject: [PATCH] Update README --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ec76d11..8ede02f 100644 --- a/README.md +++ b/README.md @@ -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) +