portersky
98673b57ff
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.
50 lines
885 B
Markdown
50 lines
885 B
Markdown
# cuber
|
|
|
|
`cuber` is an OpenGL 3D renderer with multiple scenes.
|
|
|
|
## Requirements
|
|
|
|
- CMake 3.21+
|
|
- Ninja
|
|
- C++23 compiler
|
|
|
|
All dependencies (fmt, GLFW, GLAD, asio, GLM, stb) are fetched
|
|
automatically via CMake FetchContent.
|
|
|
|
## Development
|
|
|
|
**Configure**:
|
|
|
|
```sh
|
|
cmake -S . -B build -GNinja
|
|
```
|
|
|
|
**Build**:
|
|
|
|
```sh
|
|
ninja -C build
|
|
```
|
|
|
|
**Run**:
|
|
|
|
```sh
|
|
./build/cuber
|
|
```
|
|
|
|
## Usage
|
|
|
|
```
|
|
--duration <seconds> Auto-terminate after N seconds (for testing/CI)
|
|
--scene <cube|sphere> Select initial scene (default: cube)
|
|
--screenshot Render one frame, save screenshot, and exit
|
|
S key Take screenshot (saved as screenshot.png)
|
|
1/2 key Switch between cube/sphere scene
|
|
Q key Quit
|
|
```
|
|
|
|
## Scenes
|
|
|
|
- **cube** — spinning colored cube with per-face colors
|
|
- **sphere** — cube-to-sphere mapped mesh with per-face colors and
|
|
diffuse lighting
|