BadQuanta
44 lines
1.2 KiB
Markdown
44 lines
1.2 KiB
Markdown
# H.D.K. -- Hollow Development Kit
|
|
|
|
Complete development environment for hollow interactive environment development on compatible grid emitter systems.
|
|
|
|
- [Doxygen generated documentation](https://ufp.institute/hdk/docs/)
|
|
- [Git repository](https://git.ufp.institute/ufp/hdk)
|
|
|
|
## Submodules
|
|
|
|
This repository is simply a collection of submodules that rely on each other to build the "hollow development kit".
|
|
The submodules are:
|
|
|
|
- [grid](./grid/README.md)
|
|
- [sdl](./sdl/README.md)
|
|
- [dimgui](./dimgui/README.md)
|
|
- [dimgui-sdl](./dimgui-sdl/README.md)
|
|
|
|
## Building
|
|
|
|
The unifying build system for all submodules is CMake and this can be configured to build all submodules at once.
|
|
|
|
To build the entire project, simply run the following commands in the root of the repository:
|
|
|
|
```bash
|
|
mkdir build
|
|
cd build
|
|
cmake ..
|
|
cmake --build .
|
|
```
|
|
|
|
This will build all submodules and create the necessary libraries and executables for development.
|
|
|
|
### Options
|
|
|
|
These control the default state of submodules so enabling them will enable them by default everywhere.
|
|
|
|
- `HDK_TESTS`
|
|
- `HDK_EXAMPLES`
|
|
- `HDK_COVERAGE`
|
|
|
|
`HDK_COVERAGE_FAIL_UNDER` is a percentage threshold for code coverage that will cause the build to fail if not met.
|
|
|
|
|