- TODO
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
This project is meant to be only a template, thus versions of the software used can be change to better suit the needs of the developer(s). If you wish to use the template as-is, meaning using the versions recommended here, then you will need:
- CMake v3.28+
- C++23
- uv
Note: *You also need to be able to provide CMake a supported generator.*
It is fairly easy to install the project, all you need to do is clone if from GitHub or generate a new repository from it (also on GitHub).
If you wish to clone the repository, rather than generate from it, you simply need to run:
git clone https://github.com/chronoinferna/obxx/To build the project, all you need to do is run:
./scripts/setup.sh
cmake --preset conan-release
cmake --build --preset conan-releaseMore options that you can set for the project can be found in the
cmake/StandardSettings.cmake file. For certain
options additional configuration may be needed in their respective *.cmake files
Note: *Windows might break everything... sorry!*
cd build/Release # if not in the build directory already
ctestPlease read CONTRIBUTING.md for details on our how you can become a contributor and the process for submitting pull requests to us.
This project makes use of SemVer for versioning. A list of existing versions can be found in the project's releases.
- Oliver Deng - @chronoinferna
This project is licensed under the Unlicense - see the LICENSE file for details