Skip to content

Commit 6da4804

Browse files
committed
Update README with architecture and technology used
1 parent 60eb8b6 commit 6da4804

1 file changed

Lines changed: 20 additions & 1 deletion

File tree

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,24 @@ mkdir build
2323
cd build
2424
cmake ..
2525
cmake --build .
26-
./src/renderer
26+
./src/renderer ../models/plant.obj
2727
```
28+
29+
## Architecture
30+
31+
![Architecture Diagram](docs/diagrams/export/architecture.svg)
32+
33+
The renderer is organized into distinct classes handling windowing, rendering, models, and materials. See the diagram above for the relationships between major components.
34+
35+
## Dependencies
36+
37+
This project uses the following third-party libraries:
38+
39+
- **OpenGL 3.3 Core** - Modern graphics API for GPU-accelerated rendering
40+
- **GLFW** - Cross-platform windowing, input handling, and OpenGL context creation
41+
- **glad** - OpenGL function loader generated for OpenGL 3.3 Core Profile
42+
- **GLM** - Header-only mathematics library providing vector and matrix operations matching GLSL
43+
- **Assimp** - Asset import library for loading 3D models (.obj, .fbx, etc.) with material and texture support
44+
- **stb_image** - Single-header image loading library for texture data (PNG, JPG, etc.)
45+
- **ImGui** - Immediate mode GUI library for runtime debugging and parameter tweaking
46+
- **CMake** - Build system for managing compilation across platforms

0 commit comments

Comments
 (0)