diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 44 |
1 files changed, 9 insertions, 35 deletions
@@ -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. |