Add CLAUDE.md with project architecture and build guide#1
Conversation
This reverts commit d117125.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
@copilot Review this change |
|
@Energy0124 I've opened a new pull request, #2, to work on those changes. Once the pull request is ready, I'll request review from you. |
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for AI-assisted development in the Enix game engine project. The CLAUDE.md file serves as a reference guide covering build instructions, architecture, coding conventions, and third-party dependencies to help AI tools understand the codebase structure.
Changes:
- Adds
CLAUDE.mdwith detailed documentation covering build process (CMake, shader compilation), subsystem architecture, render pipeline, code conventions, third-party libraries, asset paths, and planned features
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - `Enix/VulkanEngine.h/.cpp` — singleton engine; owns `Window`, `InputSystem`, `Renderer`, `AppUI`, `ThreadPool`, `Scene` | ||
|
|
There was a problem hiding this comment.
VulkanEngine.h/.cpp is described here as a “singleton engine”, but the constructor is public and the static _instance is simply overwritten in the constructor (so multiple instances can exist sequentially). Consider rewording this to “intended singleton / global instance pointer” unless the code enforces singleton semantics.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Summary
CLAUDE.mdto document the Enix game engine for AI-assisted developmentWhat's in CLAUDE.md
glslcRender/,Core/,Asset/,Input/,UI/), two-pass render pipeline (Blinn-Phong + ImGui), double-buffering, UBO layout_member prefix, singleton pattern, non-copyable render objects,#pragma oncebin/Test plan
CLAUDE.mdrenders correctly on GitHubCMakeLists.txt🤖 Generated with Claude Code