summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorskal <pascal.massimino@gmail.com>2026-02-09 19:00:51 +0100
committerskal <pascal.massimino@gmail.com>2026-02-09 19:00:51 +0100
commit46d4cb4d2cbdaa8461201680a134103b547e2063 (patch)
tree0d3cc96818994e5a6093df73f4e38e71ba19812b /README.md
parent512e0187e17ab6116c336885c1a9a6dc0a03f9d1 (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 'README.md')
-rw-r--r--README.md44
1 files changed, 9 insertions, 35 deletions
diff --git a/README.md b/README.md
index 0117a77..f7d78de 100644
--- a/README.md
+++ b/README.md
@@ -1,46 +1,20 @@
# 64k Demo Project
-This is a C++ project aiming to create a cross-platform (Windows, macOS, Linux) 64-kilobyte demo.
+Cross-platform (Windows, macOS, Linux) 64-kilobyte demoscene production.
## Quickstart
-Development setup:
-
```bash
cmake -S . -B build -DDEMO_ALL_OPTIONS=ON
-cmake --build build
+cmake --build build -j4
+./build/demo64k
```
-## Project Files
-
-- `ASSET_SYSTEM.md`: Describes the custom asset packing and management system.
-- `BUILD.md`: Instructions for building the project.
-- `CONTRIBUTING.md`: Guidelines for contributing, including coding style and commit policies.
-- `FETCH_DEPS.md`: Information on third-party dependencies.
-- `HOT_RELOAD.md`: Debug-only file change detection system.
-- `HOWTO.md`: General instructions for running and interacting with the demo.
-- `PHASE2_COMPRESSION.md`: Details on future asset compression strategies.
-- `PROCEDURAL.md`: Details on the procedural texture generation system.
-- `PROJECT_CONTEXT.md`: A comprehensive overview of the project's architecture, features, and current state.
-- `SEQUENCE.md`: Complete reference for `.seq` file format and timeline system.
-- `SIZE_MEASUREMENT.md`: Strategy for measuring core demo size vs external library overhead.
-- `SPEC_EDITOR.md`: Plans for a future web-based spectrogram editor tool.
-- `WORKSPACE_SYSTEM.md`: Multi-demo workspace organization architecture.
-- `3D.md`: Overview of the 3D rendering pipeline and future enhancements.
-- `TODO.md`: A list of immediate, small-scale tasks.
-
-## Source Code Layout
+## Documentation
-The source code is organized into the following main directories:
+- **PROJECT_CONTEXT.md** - Current status and architecture overview
+- **TODO.md** - Active tasks and priorities
+- **doc/HOWTO.md** - Common operations (building, testing, assets)
+- **doc/CONTRIBUTING.md** - Development guidelines and protocols
-- `src/`: The main C++ source code for the demo.
- - `3d/`: Core 3D rendering components (camera, scene, renderer).
- - `audio/`: Audio synthesis and processing engine.
- - `gpu/`: WebGPU rendering pipeline, effects, and shader management.
- - `procedural/`: Procedural content generation (textures, etc.).
- - `tests/`: Unit and integration tests for various components.
- - `util/`: Shared utility classes, like the asset manager.
-- `assets/`: Raw assets (audio, sequence files) that are processed and packed.
-- `scripts/`: Helper scripts for building, packaging, and running the demo.
-- `tools/`: Source code for command-line tools used in the asset pipeline (e.g., `asset_packer`, `spectool`).
-- `third_party/`: Third-party libraries like miniaudio and glfw3webgpu.
+See `doc/` for detailed technical documentation.