summaryrefslogtreecommitdiff
path: root/HOWTO.md
diff options
context:
space:
mode:
authorskal <pascal.massimino@gmail.com>2026-01-28 02:17:04 +0100
committerskal <pascal.massimino@gmail.com>2026-01-28 02:17:04 +0100
commit5722d68a3e529fb22886c2430dc0d268c33424e7 (patch)
tree0ebc89443ef5a92b8284bcd8c60f88eabb3e6e72 /HOWTO.md
parent78ec37484b92efee1627e934a6e4e43c74968f88 (diff)
feat(crunch): Add UPX-based binary packer script
Adds 'scripts/crunch_demo.sh' to automate building a stripped binary and compressing it with UPX. Updates 'FETCH_DEPS.md' with UPX installation instructions and 'HOWTO.md' with usage guide. This addresses Task 3 (add binary crunchers).
Diffstat (limited to 'HOWTO.md')
-rw-r--r--HOWTO.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/HOWTO.md b/HOWTO.md
index 60a29fa..5716524 100644
--- a/HOWTO.md
+++ b/HOWTO.md
@@ -40,6 +40,15 @@ cmake --build build
```
In this mode, the demo will always start in fullscreen.
+### Packed Build (Binary Crunching)
+
+To build the stripped binary and compress it using `UPX`, run the provided script:
+
+```bash
+./scripts/crunch_demo.sh
+```
+This requires `UPX` to be installed.
+
## Testing
**Commit Policy**: Always run tests before committing. Refer to `CONTRIBUTING.md` for details.