Skip to content

Commit 8b86b18

Browse files
committed
updating installation instructions
1 parent 17f0300 commit 8b86b18

File tree

1 file changed

+54
-29
lines changed

1 file changed

+54
-29
lines changed

ct_doc/doc/installation.dox

Lines changed: 54 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,64 @@
11
/*!
22

33
\page install_guide Installation
4-
- \subpage requirements
5-
- \subpage install
6-
7-
8-
\page requirements Requirements
94
@tableofcontents
10-
This library is written in C++11. It is tested under Ubuntu 14.04 and 16.04 with
11-
library versions as provided in the package sources.
125

6+
\section req Requirements:
7+
8+
- Ubuntu 16.04 or 18.04
9+
- a compiler with C++14 support, e.g. gcc or clang
1310

14-
\section dep Dependencies
1511

16-
- C++ compiler with C++11 support (we recommend gcc-5.4.1 or greater or clang-3.5 or greater)
17-
- <a href="http://eigen.tuxfamily.org/index.php?title=Main_Page">Eigen 3</a>
18-
- <a href="http://wiki.ros.org/catkin">catkin</a> (build system, easy to switch to CMakeLists.txt where needed). We recommend using <a href="http://catkin-tools.readthedocs.io/en/latest/verbs/catkin_build.html">catkin_tools</a>
19-
- boost 1.54 or greater (soon optional)
20-
- <a href="https://github.com/ethz-asl/kindr">kindr</a>, a kinematics library for robotics,
21-
which is required for building ct_rbd. Ideally, clone the newest version into your
22-
catkin workspace:
12+
\section dep Dependencies and building the library
13+
- install ROS, please follow the steps in <a href="http://wiki.ros.org/Installation/Ubuntu"> this tutorial</a> for your Linux distribution.
14+
- install <a href="http://eigen.tuxfamily.org/index.php?title=Main_Page">Eigen 3</a> via
15+
\code{.sh}
16+
sudo apt-get update
17+
sudo apt-get install libeigen3-dev
18+
\endcode
19+
- install the <a href="http://catkin-tools.readthedocs.io/en/latest/verbs/catkin_build.html">catkin_tools</a> build system
20+
\code{.sh}
21+
sudo sh -c 'echo "deb http://packages.ros.org/ros/ubuntu `lsb_release -sc` main" > /etc/apt/sources.list.d/ros-latest.list'
22+
wget http://packages.ros.org/ros.key -O - | sudo apt-key add -
23+
sudo apt-get update
24+
sudo apt-get install python-catkin-tools
25+
\endcode
26+
- install boost
2327
\code{.sh}
24-
$ git clone https://github.com/ethz-asl/kindr.git
28+
sudo apt-get install libboost-all-dev
2529
\endcode
30+
- create a catkin workspace and initialize it
31+
\code{.sh}
32+
mkdir -p ~/catkin_ws/src
33+
cd ~/catkin_ws
34+
catkin init
35+
\endcode
36+
37+
- install the <a href="https://github.com/ethz-asl/kindr">kindr</a> library
38+
\code{.sh}
39+
cd ~/catkin_ws/src
40+
git clone https://github.com/ANYbotics/kindr.git
41+
\endcode
42+
43+
- finally, clone the control toolbox and build your workspace
44+
\code{.sh}
45+
cd ~/catkin_ws/src
46+
git clone https://github.com/ethz-adrl/control-toolbox.git
47+
catkin build -DCMAKE_BUILD_TYPE=Release
48+
\endcode
49+
50+
- if you would like to run an example, build the library with
51+
\code{.sh}
52+
cd ~/catkin_ws/src
53+
catkin build -DCMAKE_BUILD_TYPE=Release -DBUILD_EXAMPLES=true
54+
\endcode
55+
Now, try to run the examples, e.g. the optimal control and optimal filtering examples:
56+
\code{.sh}
57+
cd ~/catkin_ws/src
58+
catkin build -DCMAKE_BUILD_TYPE=Release -DBUILD_EXAMPLES=true
59+
rosrun ct_optcon ex_NLOC
60+
rosrun ct_optcon ex_KalmanFiltering
61+
\endcode
2662

2763

2864
\section opt_dep Optional Dependencies and Bindings
@@ -60,19 +96,8 @@ The following dependencies and bindings are optional but can help to enhance the
6096
\endcode
6197

6298

63-
\page install Compile
64-
@tableofcontents
65-
66-
\section build_lib Build the library
67-
68-
In order to build the library, execute the following commands in your terminal
69-
\code{.sh}
70-
cd catkin_ws/src
71-
git clone https://github.com/ethz-asl/kindr.git
72-
git clone https://bitbucket.org/adrlab/ct.git
73-
catkin build -DCMAKE_BUILD_TYPE=RELEASE
74-
\endcode
7599

100+
\section Additional build arguments
76101
The following additional build flags are available, which can be appended to the build command above
77102

78103
Build Flag | Default value | Description
@@ -94,7 +119,7 @@ To build the documentation do
94119
\code{.sh}
95120
catkin build ct_doc -v --make-args doc # build the doc
96121
\endcode
97-
This will build the documentation and open it in your browser.
122+
This will build the documentation. The index.html can be found in ct_doc.
98123

99124

100125
\section run_tests Run Unit Tests

0 commit comments

Comments
 (0)