jeirmeister/Cockatrice
1
0
Fork 0
mirror of https://github.com/Cockatrice/Cockatrice.git synced 2026-11-05 01:23:24 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

[Readme] Add hint on building docs (#7389)
Some checks failed
CodeQL / Analyze (cpp) (push) Has been cancelled
Details
CodeQL / Analyze (actions) (push) Has been cancelled
Details
Build Desktop / Configure (push) Has been cancelled
Details
Build Docker / Servatrice (arm) (push) Has been cancelled
Details
Build Docker / Servatrice (x86) (push) Has been cancelled
Details
Build Desktop / Debian 13 (push) Has been cancelled
Details
Build Desktop / Debian 12 (push) Has been cancelled
Details
Build Desktop / Fedora 44 (push) Has been cancelled
Details
Build Desktop / Fedora 43 (push) Has been cancelled
Details
Build Desktop / Servatrice_Debian 12 (push) Has been cancelled
Details
Build Desktop / Ubuntu 26.04 (push) Has been cancelled
Details
Build Desktop / Ubuntu 24.04 (push) Has been cancelled
Details
Build Desktop / Arch (push) Has been cancelled
Details
Build Desktop / macOS 13 Intel (push) Has been cancelled
Details
Build Desktop / macOS 14 (push) Has been cancelled
Details
Build Desktop / macOS 15 (push) Has been cancelled
Details
Build Desktop / macOS 26 Debug (push) Has been cancelled
Details
Build Desktop / Windows 10 (push) Has been cancelled
Details
Build Docker / Publish multi-platform Servatrice image (push) Has been cancelled
Details

Browse source 
* add hint on building docs

* Update README.md

* Update README.md

* Expand doxygen README
This commit is contained in:
tooomm 2026-10-04 21:48:10 +02:00 • committed by GitHub
parent a02523ee9e
commit b545efb929
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 17 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -160,6 +160,12 @@ The following flags (with their non-default values) can be passed to `cmake`:
| `-DUPDATE_TRANSLATIONS=1` | Configure `make` to update the translation .ts files for new strings in the source code<br> **Note:** `make clean` will remove the .ts files |
| `-DTEST=1` | Enable regression tests<br> **Note:** `make test` to run tests, *googletest* will be downloaded if not available |
> [!TIP]
> Build code documentation ([Doxygen](https://www.doxygen.nl)) according to our [configuration](https://github.com/Cockatrice/Cockatrice/blob/master/Doxyfile) into `/docs`:
> ```bash
> doxygen Doxyfile
> ```
# Run