Stereo Parallel

Contents

• Contributing
• Build the project
• Using the application
• Documentation
• Using the code

Contributing

Before adding any changes, read Code of Conduct and CONTRIBUTING guide.

Build the project

The project uses CMake of version 3.1 and higher. To build the project in Linux,

• clone it,
• create a directory to build the project in,
• go there and call cmake specifying root as the parameter,
• build the project using cmake --build or your build system (make?).

git clone https://github.com/char-lie/stereo-parallel.git
mkdir stereo-parallel/build
cd build
cmake ..
cmake --build .

If you want to use OpenMP, you should install it first, and build the project with -DWITH_OPENMP=ON flag

git clone https://github.com/char-lie/stereo-parallel.git
mkdir stereo-parallel/build
cd build
cmake -DWITH_OPENMP=ON ..
cmake --build .

After build, it's recommended to run tests in order to make sure that all works fine. This can be done by executing ctest in build directory. Here is a bash script for download, build and test

git clone https://github.com/char-lie/stereo-parallel.git
mkdir stereo-parallel/build
cd build
cmake ..
cmake --build .
ctest

Using the application

After build, your build/lib directory should contain stereo_parallel executable file. Launch it without parameters to see the help.

Documentation

The project has online documentation.

You can also build it locally and read it offline from build/docs directory. First, you should install Doxygen and Graphviz. Under Ubuntu you can do it by

sudo apt install doxygen graphviz

Then, you can build the documentation using CMake. Just enable BUILD_DOC flag

cmake .. -DBUILD_DOC=ON
cmake --build .

Using the code

The project is licensed under MIT License. You can freely copy and use the code in your project (even if it's commercial and its source code is closed). When you modify some files,

• leave Copyright (c) 2018-2021 char-lie at the top of modified file(s),
• write your own copyright under it,
• write license text you want to use (or leave MIT License if you use it).

It's explained in answer to How to manage a copyright notice in an open source project?.