docs: update README and AGENTS.md to match current project
Updated project description from 'cube timer' to 'OpenGL 3D renderer with multiple scenes'. Added usage section with CLI flags and key bindings. Listed both available scenes. Updated AGENTS.md to include the sphere scene in static libraries and source layout. Normalized run command to ./build/cuber for cross-platform consistency.
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
|
||||
## Project Overview
|
||||
|
||||
`cuber` is a simple cube timer application.
|
||||
`cuber` is an OpenGL 3D renderer with multiple scenes.
|
||||
|
||||
## Build System
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
```sh
|
||||
cmake -S . -B build -GNinja
|
||||
ninja -C build
|
||||
.\build\cuber.exe
|
||||
./build/cuber
|
||||
```
|
||||
|
||||
### Dependencies
|
||||
@@ -36,7 +36,8 @@ The project is split into static libraries:
|
||||
|
||||
- **`cbt_opengl`** — OpenGL abstraction and window management (window, context, buffer, texture, vao, shader, descriptor)
|
||||
- **`cbt_scene`** — Base scene class
|
||||
- **`scenes_cube`** — Cube scene implementation
|
||||
- **`scenes_cube`** — Spinning cube scene implementation
|
||||
- **`scenes_sphere`** — Cube-to-sphere mapped mesh with diffuse lighting
|
||||
|
||||
### CMake Module Path
|
||||
|
||||
@@ -120,6 +121,8 @@ cuber/
|
||||
scenes/ # Application scenes
|
||||
cube.hpp # Spinning cube scene
|
||||
cube.cpp # Cube scene implementation
|
||||
sphere.hpp # Cube-to-sphere mapped mesh
|
||||
sphere.cpp # Sphere scene implementation
|
||||
deps/ # Custom Find*.cmake scripts
|
||||
Findfmt.cmake # fmt library
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user