35 lines
875 B
Markdown
35 lines
875 B
Markdown
# sophia
|
|
|
|
|
|
|
|
## Getting Started
|
|
|
|
COMING SOON
|
|
|
|
## Developing on the engine
|
|
|
|
### Dependencies
|
|
|
|
- [cmake](https://cmake.org/) 3.25+
|
|
- [Ninja](https://ninja-build.org/)
|
|
- [Vulkan SDK](https://vulkan.lunarg.com/) - With validation layers
|
|
|
|
### Build instructions
|
|
|
|
Builds use the presets in `CMakePresets.json` (`debug`, `release`), each in its own `build/<preset>` directory:
|
|
|
|
```sh
|
|
cmake --preset debug
|
|
cmake --build --preset debug
|
|
```
|
|
|
|
Or with the dev helper: `dev build [preset] [--fresh]`.
|
|
|
|
## Third Party libraries used
|
|
|
|
- [GLFW](https://github.com/glfw/glfw) - Window and input handling
|
|
- [GLM](https://github.com/g-truc/glm) - Vector/matrix math
|
|
- [Dear ImGui](https://github.com/ocornut/imgui) (docking branch) - Debug/editor UI
|
|
- [EnTT](https://github.com/skypjack/entt) - Entity-component system
|
|
- [Vulkan SDK](https://vulkan.lunarg.com/)
|