New build system + hysh functionality

2026-02-21 12:49:57 -06:00
parent 0655f2a39e
commit 3cc1459769
23 changed files with 269 additions and 934 deletions
@@ -0,0 +1,68 @@
+## Building
+
+### Linux / `make`-compatible systems
+
+Run:
+
+```bash
+make build
+```
+
+Optional variables:
+
+* **`ARCH=`**
+
+  * `cct` Build using the cct bootloader
+  * `oc` Build using the oc bootloader
+
+* **`DEV=1`**
+
+  * Builds in development mode
+  * Bootloader does not start automatically on system startup
+
+If `DEV` is not specified:
+
+* Default is release mode
+* Bootloader starts automatically on system startup
+
+**Examples**
+
+```bash
+make build ARCH=cct
+make build ARCH=oc DEV=1
+```
+
+---
+
+### Windows / Any system with Python 3.7+
+
+Run:
+
+```bash
+python build.py build
+```
+
+Optional arguments:
+
+* **`--arch {cct|oc}`**
+  Select bootloader
+
+  * `cct` Use the cct bootloader
+  * `oc` Use the oc bootloader
+
+* **`--dev`**
+
+  * Development mode
+  * Bootloader does not start automatically
+
+* **`--release`** (default)
+
+  * Release mode
+  * Bootloader starts automatically
+
+**Examples**
+
+```bash
+python build.py build --arch cct
+python build.py build --arch oc --dev
+```