diff options
| author | coco875 <59367621+coco875@users.noreply.github.com> | 2023-10-14 05:04:33 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-10-13 21:04:33 -0600 |
| commit | d71e1c7b708e5caab3be4603474cedf1fd3b9893 (patch) | |
| tree | bb0491fa0b815b6f66b007ca2a117c94ff60aeb6 /README.md | |
| parent | 10e0e61731a976c60a3273d7375f2df396d9258e (diff) | |
finish setup doxygen (#458)
* update and setup doxygen file
* move to docs/html
* Readme - Add link to the documentation
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 5 |
1 files changed, 5 insertions, 0 deletions
@@ -106,6 +106,11 @@ Some menu textures are compressed using a format called tkmk00. A byte-matching | └── trophy: ceremony cutscene podium and trophy textures └── tools: build tools +## Documentation + +[Doxygen](https://www.doxygen.nl/index.html) is used to generate documentation. To generate the documentation, run `doxygen Doxyfile` from the project root. The documentation will be generated in the `docs/html` folder. +The documentation is also available online at [https://n64decomp.github.io/mk64/](https://n64decomp.github.io/mk64/). + ## Contributing Pull requests are welcome. For major changes, please discuss in the Discord. |