ktyl
/
basalt
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update docs

This commit is contained in:
Vladyslav Usenko 2020-04-29 11:24:25 +02:00
parent 0b0399a1f9
commit fa63b64c8a
2 changed files with 10 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -30,27 +30,14 @@ Calibration (describes B-spline trajectory representation used in camera-IMU cal
## Installation ## Installation
### APT installation for Ubuntu 20.04, 18.04 and 16.04 (Fast) ### APT installation for Ubuntu 20.04, 18.04 and 16.04 (Fast)
Set up keys Set up keys, add the repository to the sources list, update the Ubuntu package index and install Basalt:
``` ```
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 0D97B6C9 sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 0D97B6C9
``` sudo sh -c 'echo "deb [arch=amd64] http://packages.usenko.eu/ubuntu $(lsb_release -sc) main" > /etc/apt/sources.list.d/basalt.list'
Add the repository to the sources list. On **Ubuntu 20.04** run:
```
sudo sh -c 'echo "deb [arch=amd64] http://packages.usenko.eu/ubuntu focal main" > /etc/apt/sources.list.d/basalt.list'
```
On **Ubuntu 18.04** run:
```
sudo sh -c 'echo "deb [arch=amd64] http://packages.usenko.eu/ubuntu bionic main" > /etc/apt/sources.list.d/basalt.list'
```
On **Ubuntu 16.04** run:
```
sudo sh -c 'echo "deb [arch=amd64] http://packages.usenko.eu/ubuntu xenial main" > /etc/apt/sources.list.d/basalt.list'
```
Update the Ubuntu package index and install Basalt:
```
sudo apt-get update sudo apt-get update
sudo apt-get install basalt sudo apt-get install basalt
``` ```
### Source installation for Ubuntu >= 18.04 and MacOS >= 10.14 Mojave ### Source installation for Ubuntu >= 18.04 and MacOS >= 10.14 Mojave
Clone the source code for the project and build it. For MacOS you should have [Homebrew](https://brew.sh/) installed. Clone the source code for the project and build it. For MacOS you should have [Homebrew](https://brew.sh/) installed.
``` ```

14
doc/DevSetup.md
View File

@ -1,14 +1,14 @@
### Clang-format ### 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. 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 10 on all platforms.
On **Ubuntu 18.04** run the following commands to install clang-format-9 On **Ubuntu 20.04 or 18.04** run the following commands to install clang-format-10
``` ```
wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key|sudo apt-key add - 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-9 main" > /etc/apt/sources.list.d/llvm9.list' sudo sh -c 'echo "deb http://apt.llvm.org/$(lsb_release -sc)/ llvm-toolchain-$(lsb_release -sc)-10 main" > /etc/apt/sources.list.d/llvm10.list'
sudo apt-get update sudo apt-get update
sudo apt-get install clang-format-9 sudo apt-get install clang-format-10
``` ```
On **MacOS** [Homebrew](https://brew.sh/) should install the right version of clang-format: On **MacOS** [Homebrew](https://brew.sh/) should install the right version of clang-format:
@ -19,7 +19,7 @@ brew install clang-format
### Realsense Drivers (Optional) ### Realsense Drivers (Optional)
If you want to use the code with Realsense T265 cameras you should install the realsense library. If you want to use the code with Realsense T265 cameras you should install the realsense library.
On **Ubuntu 18.04** run the following commands: On **Ubuntu 20.04 or 18.04** run the following commands:
``` ```
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-key C8B3A55A6F3EFCDE sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-key C8B3A55A6F3EFCDE
sudo sh -c 'echo "deb http://realsense-hw-public.s3.amazonaws.com/Debian/apt-repo bionic main" > /etc/apt/sources.list.d/realsense.list' sudo sh -c 'echo "deb http://realsense-hw-public.s3.amazonaws.com/Debian/apt-repo bionic main" > /etc/apt/sources.list.d/realsense.list'
@ -33,7 +33,7 @@ brew install librealsense
``` ```
### Install and configure QtCreator ### Install and configure QtCreator
Download and install QtCreator. On **Ubuntu 18.04** run: 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 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 chmod +x qt-creator-opensource-linux-x86_64-4.10.0.run
@ -53,7 +53,7 @@ Go to `Tools` -> `Options` and select the Beautifier tab. There select ClangForm
![qt_creator_beautifier_general](/doc/img/qt_creator_beautifier_general.png) ![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`. 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-10`.
![qt_creator_beautifier_clang_format](/doc/img/qt_creator_beautifier_clang_format.png) ![qt_creator_beautifier_clang_format](/doc/img/qt_creator_beautifier_clang_format.png)