add build and test instructions to readme

This commit is contained in:
2026-05-07 23:56:48 -05:00
parent 35cc73b04f
commit b7e509ce96
2 changed files with 48 additions and 4 deletions

View File

@@ -8,10 +8,46 @@ The maiden project is a GPU accelerated 3D rendering engine built with C++ based
## Getting Started
### git instructions here
### build instructions here
### Clone Repository
```bash
$ git clone https://git.vxbard.net/homeburger/maiden.git
# If there's any necessary submodules then:
$ git clone --recurse-submodules https://git.vxbard.net/homeburger/maiden.git
# If you have already cloned the repository and you need its submodules:
$ git submodule update --init --recursive
```
### Build
This app uses CMake and C++20, so a compatible compiler (gcc8, clang9, msvc16) are necessary.
Most library prerequisites are handled within CMake. Any others that need to be manually installed will be described below as the project grows.
To build the project (using default build directory "build"):
```bash
# configure
$ cmake -S . -B build # + any extra options
# build
$ cmake --build build -j
# execute
$ cd build
$ ./maiden
```
### Testing
This app uses GoogleTest for building unit tests. The below instructions use ctest and gcovr for test execution and code coverage:
```bash
# execute unit tests
$ ctest -T Test # + filter options
# analyze code coverage
$ cd build
$ gcovr -r .. --filter "../src"
```
### app troubleshooting here
### testing instructions here
## Development Roadmap
### lots of todo here