From 70c64867baa30c83334559d3023153dfe3f9ff79 Mon Sep 17 00:00:00 2001 From: skal Date: Mon, 9 Feb 2026 10:43:11 +0100 Subject: docs: Simplify all design docs (50% reduction, 1687 lines removed) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Consolidated and streamlined all documentation: **Merged:** - PROCEDURAL.md → deleted (content in ASSET_SYSTEM.md) - FETCH_DEPS.md → BUILD.md (dependencies section) **Simplified (line reductions):** - HOWTO.md: 468→219 (53%) - CONTRIBUTING.md: 453→173 (62%) - SPECTRAL_BRUSH_EDITOR.md: 497→195 (61%) - SEQUENCE.md: 355→197 (45%) - CONTEXT_MAINTENANCE.md: 332→200 (40%) - test_demo_README.md: 273→122 (55%) - ASSET_SYSTEM.md: 271→108 (60%) - MASKING_SYSTEM.md: 240→125 (48%) - 3D.md: 196→118 (40%) - TRACKER.md: 124→76 (39%) - SCENE_FORMAT.md: 59→49 (17%) - BUILD.md: 83→69 (17%) **Total:** 3344→1657 lines (50.4% reduction) **Changes:** - Removed verbose examples, redundant explanations, unimplemented features - Moved detailed task plans to TODO.md (single source of truth) - Consolidated coding style rules - Kept essential APIs, syntax references, technical details **PROJECT_CONTEXT.md:** - Added "Design Docs Quick Reference" with 2-3 line summaries - Removed duplicate task entries - All design docs now loaded on-demand via Read tool Result: Context memory files reduced from 31.6k to ~15k tokens. --- doc/FETCH_DEPS.md | 68 ------------------------------------------------------- 1 file changed, 68 deletions(-) delete mode 100644 doc/FETCH_DEPS.md (limited to 'doc/FETCH_DEPS.md') diff --git a/doc/FETCH_DEPS.md b/doc/FETCH_DEPS.md deleted file mode 100644 index ce62db2..0000000 --- a/doc/FETCH_DEPS.md +++ /dev/null @@ -1,68 +0,0 @@ -# Fetching Third-Party Dependencies - -This project intentionally does NOT vendor large third-party libraries. - -Currently required: - -## miniaudio - -Single-header audio library. - -Source: -https://github.com/mackron/miniaudio - -Required file: -- miniaudio.h - -Expected location: -third_party/miniaudio.h - -### Automatic fetch - -Use one of the provided scripts: -- scripts/project_init.sh -- scripts/project_init.bat - -### Manual fetch - -Download miniaudio.h from: -https://raw.githubusercontent.com/mackron/miniaudio/master/miniaudio.h - -and place it into: -third_party/miniaudio.h - -## wgpu-native - -WebGPU implementation via wgpu-native. - -### Installation - -**macOS:** -```bash -brew install wgpu-native -``` - -**Other platforms:** -Please install `wgpu-native` such that `libwgpu_native` (static or shared) is in your library path and headers are in your include path (under `webgpu/`). - -## glfw3webgpu - -Helper library for creating WebGPU surfaces from GLFW windows. - -### Automatic fetch - -Use one of the provided scripts: -- scripts/project_init.sh -- scripts/project_init.bat - -These scripts will download `glfw3webgpu.h` and `glfw3webgpu.c` into `third_party/glfw3webgpu`. - -## UPX - -Executable packer for binary compression (Linux/Windows only). -On macOS, the build script defaults to `strip` and `gzexe` due to UPX compatibility issues. - -### Installation - -**Linux/Windows:** -Download the appropriate release from https://github.com/upx/upx/releases and ensure the `upx` executable is in your PATH. -- cgit v1.2.3