[Readme] Add hint on building docs (#7389)

* add hint on building docs * Update README.md * Update README.md * Expand doxygen README
2026-11-05 09:33:25 -08:00 · 2026-10-04 21:48:10 +02:00 · 2026-10-04 21:48:10 +02:00 · b545efb929
commit b545efb929
parent a02523ee9e
2 changed files with 17 additions and 0 deletions
--- a/doc/doxygen/README.md
+++ b/doc/doxygen/README.md
@ -1,3 +1,14 @@
+## Building Doxygen Documentation
+
+We use [Doxygen](https://www.doxygen.nl) for our code documentation.  
+After installing the tool, you can build a HTML webpage into `/docs` folder according to our [configuration](https://github.com/Cockatrice/Cockatrice/blob/master/Doxyfile):
+```bash
+doxygen Doxyfile
+```
+Open the `index.html` file in the `/docs/html/` folder to view and use it.  
+There is also an online version we host at the Cockatrice webpage: [cockatrice.github.io/docs](https://cockatrice.github.io/docs)
+
+
 ## Doxygen Documentation Theme

 Required changes to the `Doxyfile` config from the [theme docs](https://jothepro.github.io/doxygen-awesome-css/index.html#autotoc_md16) to make [doxygen-awesome-css](https://github.com/jothepro/doxygen-awesome-css) work: