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 11 on all platforms.
On Ubuntu 20.04 or 18.04 run the following commands to install clang-format-11
wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key|sudo apt-key add -
sudo sh -c 'echo "deb http://apt.llvm.org/$(lsb_release -sc)/ llvm-toolchain-$(lsb_release -sc)-11 main" > /etc/apt/sources.list.d/llvm11.list'
sudo apt-get update
sudo apt-get install clang-format-11
On MacOS Homebrew should install the right version of clang-format:
brew install clang-format
Download and install QtCreator. On Ubuntu 20.04 or 18.04 run:
wget https://download.qt.io/official_releases/qtcreator/4.10/4.10.0/qt-creator-opensource-linux-x86_64-4.10.0.run
chmod +x qt-creator-opensource-linux-x86_64-4.10.0.run
./qt-creator-opensource-linux-x86_64-4.10.0.run
On MacOS run:
brew cask install qt-creator
After installation, go to Help -> About plugins... in the menu and enable Beautifier plugin (formats the code automatically on save):
Go to Tools -> Options and select the Beautifier tab. There select ClangFormat as the tool in General tab.
Select file as predefined style in Clang Format tab. Also select None as the fallback style. For Ubuntu 20.04 or 18.04 change the executable name to /usr/bin/clang-format-11.
First, clone the project repository.
git clone --recursive https://github.com/DLR-RM/granite.git
After that, in QtCreator open to the CMakeLists.txt in the granite folder and configure the project with Release with Debug Info configuration. The build directory should point to /<your_installation_path>/granite/build.
Finally, you should be able to build and run the project.