summaryrefslogtreecommitdiff
path: root/doc/BUILD.md
diff options
context:
space:
mode:
authorskal <pascal.massimino@gmail.com>2026-02-02 12:19:10 +0100
committerskal <pascal.massimino@gmail.com>2026-02-02 12:19:10 +0100
commitdc47af28f09705d28e9975867d7fad9a395f9163 (patch)
tree5ae97b21542d2824c9c9d422ed1b4a25331fa1a2 /doc/BUILD.md
parenta5b27673c29ca39b6b35bb0f5c4be224d7b41b5a (diff)
refactor(build): Centralize generated files and clean up project layout
- Task A: Centralized all generated code (assets, timeline) into a single directory to create a single source of truth. - Task A: Isolated test asset generation into a temporary build directory, preventing pollution of the main source tree. - Task B: Vertically compacted all C/C++ source files by removing superfluous newlines. - Task C: Created a top-level README.md with project overview and file descriptions. - Task D: Moved non-essential documentation into a directory to reduce root-level clutter.
Diffstat (limited to 'doc/BUILD.md')
-rw-r--r--doc/BUILD.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/BUILD.md b/doc/BUILD.md
new file mode 100644
index 0000000..3a581b1
--- /dev/null
+++ b/doc/BUILD.md
@@ -0,0 +1,29 @@
+# Build Instructions
+
+Debug build:
+cmake -S . -B build
+cmake --build build
+
+Size-optimized build:
+cmake -S . -B build -DDEMO_SIZE_OPT=ON
+cmake --build build
+
+## Windows Cross-Compilation (from macOS)
+
+Requires `mingw-w64` and `wine-stable` (for testing).
+
+1. Fetch Windows binaries:
+ ```bash
+ ./scripts/fetch_win_deps.sh
+ ```
+
+2. Build for Windows:
+ ```bash
+ ./scripts/build_win.sh
+ ```
+ This will produce `build_win/demo64k_packed.exe`.
+
+3. Run with Wine:
+ ```bash
+ ./scripts/run_win.sh
+ ```