2. Repository Cloning & Structure

Cloning the Project to your PC.

To clone the project, follow these steps.

1. Download and install the GitHub Desktop Client from here: https://desktop.github.com/
2. Create an account and login if not already done.
3. On this project's home page click "Clone or Download", and copy the path "https://github.com/patrobic/BlindAid.git"
4. In the Desktop Client, click "Clone a Repository", paste the path.
5. Click "Choose", set the clone path to "C:\Projects\BlindAid", and click OK.
6. Click "Clone". Once complete, browse to the project path and open "BlindAid.sln".

Clone Location

The project should be cloned into the following folder.

C:\Projects\BlindAid

Because relative paths are used, the project path should not matter. However, unforeseen issues could arise if someone uses absolute paths, so it is safer if we all use the same root path.

Repository Structure

Within this folder, there are the following subfolders.

BlindAid: Visual Studio solution file and one folder per Project.
    BlindAid: Source code for all Modules of the BlindAid Project.
    UnitTest: Classes containing Unit Tests (TEST_CLASS -> TEST_METHOD).
TestData: Sample images and videos, separated into subfolders by module (ex. TrafficLight).
    ModuleName: Images should be grouped in sets with the same file name, followed by a number (ex. tlight1.jpg).
Dependencies: Supporting libraries and SDKs, separated into subfolders (ex. OpenCV).
    DependencyName: DLLs and Libraries in separate subfolders.
        lib: Libraries (*.lib)
        bin: Dynamic Link Libraries (*.dll)