From c793140e0fbe76068dd6f1b840bbfdff317cb4fe Mon Sep 17 00:00:00 2001 From: Abdelrahman Said Date: Sun, 28 Jun 2026 13:53:29 +0100 Subject: [PATCH] README --- AGENTS.md | 8 ++++++++ README.md | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 43 insertions(+) create mode 100644 README.md diff --git a/AGENTS.md b/AGENTS.md index bf1adea..82a2260 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -193,6 +193,14 @@ documents/ a summary; iterate on the plan before writing any code. 3. Only start implementing after the plan is approved. +### README + +Keep `README.md` in sync with the project as it evolves. Update it when: +- The directory layout changes meaningfully +- Language, toolchain, or build system decisions are settled +- Dependencies are added or removed +- The project reaches a notable milestone + ### Learning from edits The user may edit code produced by AI agents. When this happens, infer the diff --git a/README.md b/README.md new file mode 100644 index 0000000..de6e801 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# Prism + +A node-based image compositing tool. Images flow through a directed acyclic +graph (DAG) of processing nodes (read, blend, colour-grade, etc.) and are +rendered via GPU shaders. + +## Status + +Early development. Scaffolding and exploratory scratchpad work. + +## Language & Tooling + +- **Language**: C11 / C++11 (dual-mode), following conventions in `src/wapp/` +- **GPU API**: Vulkan, abstracted behind a Rendering Hardware Interface (RHI) +- **Shading language**: Slang (`src/shaders/`) +- **Build**: TBD + +## Dependencies + +- `src/wapp/` — local utility library (vendored, provides allocators, arrays, + strings, platform abstractions, etc.) + +## Project layout + +``` +src/prism/prism.h umbrella include +src/prism/core/ graph, node types, DAG +src/prism/rhi/ rendering hardware interface +src/prism/node/ node implementations +src/prism/app/ entry point, window, main loop +src/shaders/ Slang shader sources +src/wapp/ vendored utility library +documents/ research notes and plans +references/ third-party reference implementations +```