diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8a77b76..b2caf80 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,10 +7,18 @@ I don't currently have a road map as i'm working on getting basic features imple - `git submodule init` - `git submodule update` 2. Install the dependencies - - `gcc` + - `gcc` and `g++` - `cmake >= 3.14` - `qt5 >= 5.15.0` (must include development pacakges!) + - `qt5-base` + - `qt5-websockets` + - `qt5-quickcontrols` + - `qt5-quickcontrols2` - `ninja` (optional) 4. From the project root dir run: - 1. `cmake -DCMAKE_BUILD_TYPE:STRING=Debug -B./.build -G Ninja` leave off the `-G Ninja` part if you didn't install ninja - 2. `cmake --build .build --config Debug --target all -- -j12` (or how ever many threads you want to build with) + - Debug config + 1. `cmake -DCMAKE_BUILD_TYPE:STRING=Debug -B./.build -G Ninja` leave off the `-G Ninja` part if you didn't install ninja + 2. `cmake --build .build --config Debug --target all -- -j12` (or how ever many threads you want to build with) + - Release config + 1. `cmake -DCMAKE_BUILD_TYPE:STRING=Release -B./.build -G Ninja` leave off the `-G Ninja` part if you didn't install ninja + 2. `cmake --build .build --config Release --target all -- -j12` (or how ever many threads you want to build with)