diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..aff5251 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# 64k Demo Project + +This is a C++ project aiming to create a cross-platform (Windows, macOS, Linux) 64-kilobyte demo. + +## 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. +- `HOWTO.md`: General instructions for running and interacting with the demo. +- `PROCEDURAL.md`: Details on the procedural texture generation system. +- `PROJECT_CONTEXT.md`: A comprehensive overview of the project's architecture, features, and current state. +- `SPEC_EDITOR.md`: Plans for a future web-based spectrogram editor tool. +- `TODO.md`: A list of immediate, small-scale tasks. + +## Source Code Layout + +The source code is organized into the following main directories: + +- `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. |