mirrors/hyperrogue
1
0
Fork 0
mirror of https://github.com/zenorogue/hyperrogue.git synced 2026-01-02 18:29:03 +00:00
Code Issues Releases Wiki Activity

in README.md, added an information about mymake not being perfect, and also suggest -O3

Browse Source
This commit is contained in:
Zeno Rogue
2025-12-25 09:57:49 +01:00
parent 9521e314cd
commit 6c8e4ba733
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@@ -65,12 +65,13 @@ HYPERROGUE_USE_GLEW=1 HYPERROGUE_USE_PNG=1 make
```
The `mymake` program builds HyperRogue in parts. It takes longer than the method shown above, but it uses significantly less memory during compilation, and when you change something, `mymake` will only recompile the changed file.
(Note: mymake is not perfect, and will not work correctly if the internal layout of structs has been changed. So, if you pull the new version after a long time, you should probably force a clean build by doing `rm -f mymake_files` first.)
Additionally, it can be easily configured, e.g., to produce an optimized build, or to include addons (see `mymake.cpp` for some example invocations, and `devmods` for some example addons).
Most useful parameters include `-O3` (optimized build), `-rv` (include the RogueViz demos), `-vr` (build the VR version). Compiler flags like `-Werror` (treat warnings as errors) and `-march=native` work too.
```
make mymake && ./mymake
make mymake && ./mymake -O3
```
The source code is not documented very well. You can see the current state of the documentation, as generated by Doxygen, [here](https://zenorogue.github.io/hyperrogue-doc/).