Table of Contents
The project is developed according to c++17 standards.
To build the engine, you will need the CMake build tool v3.8+
You will also need a compiler for c++17, make sure yours is compatible (gcc v8+, see support)
The program has been tested with the following compilers:
- Linux: GCC (GNU Compiler Collection)
- Windows: Mingw (Minimalist GNU for Windows)
- Download the project source or clone it with git:
git clone https://github.com/qualeus/engine.git - Create a build directory:
cd engine && mkdir build - Build the project with Cmake:
cd build && cmake -G "YOUR_COMPILER" -DBUILD_TESTS=ON ../.. - Build the targets and run tests:
cmake --build . && make CTEST_OUTPUT_ON_FAILURE=TRUE test
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Distributed under the MIT License. See LICENSE.txt for more information.
- LHOUTELLIER Maël - Initial work - mlhoutel