Developer guide

Develop AiTrack

This guide is aimed at developers who want to contribute to the project.

Visual Studio 2019 (at least). Or MSBuild tools for C++.
Qt framework: AITrack has been developed using version 5.9.9 and also tested with the most recent version at the moment (5.15), so it should work with the latest one.
cmake: For setting up the project/dependencies.

Clone this repo: git clone --recurse-submodules https://github.com/AIRLegend/aitrack
Cd into the directory: cd aitracker.
Download and unpack dependencies: cmake .
Open Camera.sln with Visual Studio (or build it with msbuild Camera.sln).
Copy the models/ dir to the same location as Client.exe.
Copy the necessary .dlls to the executable directory (libusb.dll, onnxruntime.dll, opencv_world430.dll). And then you can run windeployqt <.exe path> to let Qt auto-copy the remaining .dlls.
You should be good to go!

Create a fork of the repo and clone it on your local machine.
Once cloned, create a new branch for your feature/fix.
Try to document your code in order to debug/review it better.
Test your feature building and using the program.
If possible, squash all your commits into one with clear explanation of the changes.
Push your code to your fork.
Make a pull request.
- To /master if you consider is a fully functional feature.
- To /dev if it's part of something bigger that needs to be further developed.

You can start with anything (documentation, code cleaning...) and when you're more familiar with the codebase, try getting yout hands dirtier!

Thank you if you decide to contribute!