From 002ab9094f638c46d5db95d478e71c10933aceb2 Mon Sep 17 00:00:00 2001 From: skal Date: Mon, 9 Feb 2026 18:37:38 +0100 Subject: docs: Condense HOWTO.md, move details to technical docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - HOWTO.md: 184→97 lines (quick reference only) - BUILD.md: Add build modes, header organization, dependency tracking - ASSET_SYSTEM.md: Add developer workflow section - TRACKER.md: Add AudioEngine API documentation Net: -147 lines in HOWTO.md --- doc/ASSET_SYSTEM.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'doc/ASSET_SYSTEM.md') diff --git a/doc/ASSET_SYSTEM.md b/doc/ASSET_SYSTEM.md index 4e34378..8f31a6a 100644 --- a/doc/ASSET_SYSTEM.md +++ b/doc/ASSET_SYSTEM.md @@ -89,6 +89,21 @@ Runtime: First `GetAsset()` call invokes generator, caches result. - **Hardcoded procedural dimensions**: Assumes 256×256 RGBA8 - **No integrity checks**: No CRC/hash validation +## Developer Workflow + +**Add new asset:** +1. Place file in `assets/final/` +2. Edit `assets/final/demo_assets.txt`: + ``` + MY_ASSET, myfile.ext, NONE, "Description" + ``` +3. Regenerate: `./scripts/gen_assets.sh` or rebuild (auto-triggered) +4. Use in code: `GetAsset(AssetId::MY_ASSET, &size)` + +**Modify existing asset:** +- Edit source file in `assets/final/` +- CMake auto-detects change and rebuilds + ## Planned Improvements See **TODO.md** for detailed task breakdown: -- cgit v1.2.3