diff --git a/.gitignore b/.gitignore index 51704a2..6c860fd 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,6 @@ cmake-build* .idea CMakeLists.txt.user -build -thirdparty/build-* +build* scripts/eval/eval_* scripts/eval_full/eval_* diff --git a/README.md b/README.md index 8d4d4dc..784982b 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,9 @@ NOTE: It is possible to compile the code on Ubuntu 16.04, but you need to instal * [Visual-inertial odometry and mapping.](doc/VioMapping.md) * [Simulation tools to test different components of the system.](doc/Simulation.md) +## Development +* [Development environment setup.](doc/DevSetup.md) + ## Licence The code is provided under a BSD 3-clause license. See the LICENSE file for details. Note also the different licenses of thirdparty submodules. diff --git a/doc/DevSetup.md b/doc/DevSetup.md new file mode 100644 index 0000000..bba3662 --- /dev/null +++ b/doc/DevSetup.md @@ -0,0 +1,53 @@ + + +### Clang-format +We use clang-format to maintain a consistent formating of the code. Since there are small differences between different version of clang-format we use version 8 on all platforms. + +On Ubuntu 18.04 run the following commands to install clang-format-8 +``` +wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key|sudo apt-key add - +sudo sh -c 'echo "deb http://apt.llvm.org/bionic/ llvm-toolchain-bionic-8 main" > /etc/apt/sources.list.d/llvm8.list' +sudo apt-get install clang-format-8 +``` + +On MacOS [Homebrew](https://brew.sh/) should install the right version of clang-format: +``` +brew install clang-format +``` + +### Install and configure QtCreator +Download and install QtCreator. On Ubuntu 18.04 run: +``` +wget https://download.qt.io/official_releases/qtcreator/4.9/4.9.0/qt-creator-opensource-linux-x86_64-4.9.0.run +chmod +x qt-creator-opensource-linux-x86_64-4.9.0.run +./qt-creator-opensource-linux-x86_64-4.9.0.run +``` + +On MacOS run: +``` +wget https://download.qt.io/official_releases/qtcreator/4.9/4.9.0/qt-creator-opensource-mac-x86_64-4.9.0.dmg +open qt-creator-opensource-mac-x86_64-4.9.0.dmg +``` + +After installation, go to `Help` -> `About plugins...` in the menu and enable Beautifier plugin (formats the code automatically on save): + +![qt_creator_plugins](/doc/img/qt_creator_plugins.png) + +Go to `Tools` -> `Options` and select the Beautifier tab. There select ClangFormat as the tool in `General` tab. + +![qt_creator_beautifier_general](/doc/img/qt_creator_beautifier_general.png) + +Select file as predefined style in `Clang Format` tab. Also select `None` as the fallback style. **For Ubuntu 18.04** change the executable name to `/usr/bin/clang-format-8`. + +![qt_creator_beautifier_clang_format](/doc/img/qt_creator_beautifier_clang_format.png) + +### Build project +First, clone the project repository. +``` +git clone --recursive https://gitlab.com/VladyslavUsenko/basalt.git +``` + +After that, in QtCreator open to the `CMakeLists.txt` in the `basalt` folder and configure the project with `Release with Debug Info` configuration. The build directory should point to `//basalt/build`. + +Finally, you should be able to build and run the project. + diff --git a/doc/img/qt_creator_beautifier_clang_format.png b/doc/img/qt_creator_beautifier_clang_format.png new file mode 100644 index 0000000..a6d23ea Binary files /dev/null and b/doc/img/qt_creator_beautifier_clang_format.png differ diff --git a/doc/img/qt_creator_beautifier_general.png b/doc/img/qt_creator_beautifier_general.png new file mode 100644 index 0000000..e7291dd Binary files /dev/null and b/doc/img/qt_creator_beautifier_general.png differ diff --git a/doc/img/qt_creator_plugins.png b/doc/img/qt_creator_plugins.png new file mode 100644 index 0000000..cc1ba98 Binary files /dev/null and b/doc/img/qt_creator_plugins.png differ