From 6c8e4ba733fe612b595e7a34199a265809a6bdd2 Mon Sep 17 00:00:00 2001 From: Zeno Rogue Date: Thu, 25 Dec 2025 09:57:49 +0100 Subject: [PATCH] in README.md, added an information about mymake not being perfect, and also suggest -O3 --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4ab5b2f0..142c5ca9 100644 --- a/README.md +++ b/README.md @@ -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/).