diff options
| author | skal <pascal.massimino@gmail.com> | 2026-02-09 19:00:51 +0100 |
|---|---|---|
| committer | skal <pascal.massimino@gmail.com> | 2026-02-09 19:00:51 +0100 |
| commit | 46d4cb4d2cbdaa8461201680a134103b547e2063 (patch) | |
| tree | 0d3cc96818994e5a6093df73f4e38e71ba19812b /PROJECT_CONTEXT.md | |
| parent | 512e0187e17ab6116c336885c1a9a6dc0a03f9d1 (diff) | |
docs: Streamline top-level documentation
Condense README, PROJECT_CONTEXT, and TODO:
- README: Remove verbose file listings, focus on quickstart
- PROJECT_CONTEXT: Condense status, remove recent completions
- TODO: Mark Task #77 complete, remove verbose details
- WORKSPACE_SYSTEM: Mark as completed
Details moved to individual doc/ files.
Net: -76 lines
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Diffstat (limited to 'PROJECT_CONTEXT.md')
| -rw-r--r-- | PROJECT_CONTEXT.md | 80 |
1 files changed, 19 insertions, 61 deletions
diff --git a/PROJECT_CONTEXT.md b/PROJECT_CONTEXT.md index ae79bbf..ff6bc48 100644 --- a/PROJECT_CONTEXT.md +++ b/PROJECT_CONTEXT.md @@ -31,75 +31,33 @@ ## Current Status -- Audio system: Sample-accurate synchronization. Hardware playback time as master clock. Variable tempo support. Pipeline optimized (Task #72): Zero heap allocations per frame, direct ring buffer writes. Comprehensive test coverage. -- Build system: Optimized with proper asset dependency tracking -- Shader system: Parameterization complete (UniformHelper, .seq syntax). Modular with compilation tests. WGSL composability improved (`math/common_utils.wgsl`). -- 3D rendering: Hybrid SDF/rasterization with BVH acceleration and binary scene loader. Object data loading pipeline enhanced. -- Asset pipeline: Blender export script and binary scene ingestion -- Error handling: Dual macro system (`FATAL_XXX` for programming errors, `CHECK_RETURN` for recoverable errors) -- Testing: **36/36 tests passing (100%)** - All tests operational +- **Workspace system:** Multi-workspace support. Easy switching with `-DDEMO_WORKSPACE=<name>`. Shared common assets. +- **Audio:** Sample-accurate sync. Zero heap allocations per frame. Variable tempo. Comprehensive tests. +- **Shaders:** Parameterized effects (UniformHelper, .seq syntax). Modular WGSL composition. +- **3D:** Hybrid SDF/rasterization with BVH. Binary scene loader. Blender pipeline. +- **Build:** Asset dependency tracking. Size measurement. Hot-reload (debug-only). +- **Testing:** **36/36 passing (100%)** --- ## Next Up -**Active:** -- Task #5: Spectral Brush Editor [IN PROGRESS] - Procedural spectrogram tool (50-100× compression) - -**Visuals:** -- Task #52: Procedural SDF Font -- Task #53: Particles Shader Polish -- Task #55: SDF Random Planes Intersection - -**Structure:** -- Task #77: Workspace System - Self-contained demo workspaces - -**Tooling:** -- Task #54: Tracy Integration -- Task #76: External Library Size Measurement - -**Details:** See `TODO.md` and individual design docs - ---- - -## Design Docs Reference - -**Core Systems:** -- `doc/ASSET_SYSTEM.md` - Build-time asset packer, 16-byte alignment -- `doc/SEQUENCE.md` - .seq timeline format with BPM notation -- `doc/TRACKER.md` - Audio pattern system, unit-less timing -- `doc/3D.md` - Hybrid SDF raymarching with BVH acceleration - -**Formats:** -- `doc/SCENE_FORMAT.md` - Binary scene format (SCN1) -- `doc/MASKING_SYSTEM.md` - Auxiliary texture registry - -**Tools & Workflow:** -- `doc/BUILD.md` - Multi-platform builds (Debug/STRIP_ALL/FINAL_STRIP) -- `doc/SPECTRAL_BRUSH_EDITOR.md` - Procedural spectrogram tool -- `doc/WORKSPACE_SYSTEM.md` - Multi-demo organization -- `doc/HOT_RELOAD.md` - Debug-only file change detection -- `doc/SIZE_MEASUREMENT.md` - External library size measurement -- `doc/test_demo_README.md` - 16s audio/visual sync test - -**Meta:** -- `doc/CONTEXT_MAINTENANCE.md` - Context hygiene protocol +See `TODO.md` for current priorities and active tasks. --- -## Recently Completed +## Documentation -**Feb 9, 2026:** -- Size measurement system (Task #76) - Demo: 4.4MB, External: 2.0MB -- Hot-reload file watcher (debug-only, 0 bytes overhead) -- WGSL uniform buffer validation (Task #75) -- Uniform buffer alignment fixes (Task #74) - -**Feb 8, 2026:** -- Shader parametrization system (Task #73) - ---- +**Essential:** +- `doc/ARCHITECTURE.md` - System architecture and design decisions +- `doc/HOWTO.md` - Common operations and workflows +- `doc/CONTRIBUTING.md` - Development protocols -For detailed architecture, see `doc/ARCHITECTURE.md`. +**Technical Reference:** +- Core: `ASSET_SYSTEM.md`, `SEQUENCE.md`, `TRACKER.md`, `3D.md` +- Formats: `SCENE_FORMAT.md`, `MASKING_SYSTEM.md` +- Tools: `BUILD.md`, `WORKSPACE_SYSTEM.md`, `SIZE_MEASUREMENT.md` -For completed tasks history, see `doc/COMPLETED.md` and git history. +**History:** +- `doc/COMPLETED.md` - Completed tasks archive +- Git log for detailed change history |
