Contributing
The first thing anyone wanting to develop Hatchit should do is thoroughly read the repository README and project specification. These two documents give a comprehensive outline of the project and the philosophy behind it.
As a developer on Hatchit, the first necessary tools you will need are a Windows or Linux PC system. Currently these are the only target platforms. Mac support would be nice, but is not currently possible with the hardware we have. Below is a list of required tools by platform:
- Visual Studio 2015 (C++ 11/14 compiler)
- CMake 3.5+
- Git
- Vulkan supported GPU + drivers
-
GCC 3.0+ (C++11/14 compiler) or Clang
-
CMake 3.5+
-
Git
-
Vulkan supported GPU + drivers
Optional:
- CLion IDE (works well with CMake build system)
Currently, all development on Hatchit and its submodules is done on the dev branches. The master branch is reserved for official releases.
Please develop from the latest dev branch commits and submit pull-requests to the dev branch unless there is a specific reason not to.