Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
raulmur committed Jan 16, 2016
1 parent 9a55abc commit fbcb658
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,19 +48,19 @@ If you do not have already installed ROS in your computer, we recommend you to i

**If you use ROS Indigo, remove the depency of opencv2 in the manifest.xml.**

##2.3 g2o (included)
We use g2o to perform several optimizations. We include a modified copy of the library including only the components we need
and also some changes that are listed in `Thirdparty/g2o/Changes.txt`.
In order to compile g2o you will need to have installed CHOLMOD, BLAS, LAPACK and Eigen3.
##2.3 OpenCV
We use OpenCV to manipulate images and features. If you use a ROS version older than ROS Indigo, OpenCV is already included in the ROS distribution. In newer version of ROS, OpenCV is not included and you will need to install it. **We tested OpenCV 2.4**. Dowload and install instructions can be found at: http://opencv.org/

##2.4 g2o (included in Thirdparty)
We use a modified version of g2o (see original at https://github.com/RainerKuemmerle/g2o) to perform optimizations.
In order to compile g2o you will need to have installed BLAS, LAPACK and Eigen3 (at least 3.1.0).

sudo apt-get install libsuitesparse-dev
sudo apt-get install libblas-dev
sudo apt-get install liblapack-dev
sudo apt-get install libeigen3-dev

##2.4 DBoW2 (included)
We make use of some components of the DBoW2 library (https://github.com/dorian3d/DBoW2) for place recognition and feature matching. We include a modified copy of the library including only the components we need and also some modifications that are listed in `Thirdparty/DBoW2/LICENSE.txt`.
It only depends on OpenCV, but it should be included in the ROS distribution.
##2.5 DBoW2 (included in Thirdparty)
We make use of some components of the DBoW2 and DLib library (see original at https://github.com/dorian3d/DBoW2) for place recognition and feature matching. There are no additional dependencies to compile DBoW2.


#3. Installation
Expand All @@ -71,7 +71,9 @@ It only depends on OpenCV, but it should be included in the ROS distribution.

git clone https://github.com/raulmur/ORB_SLAM.git ORB_SLAM
3. Add the path where you cloned ORB-SLAM to the `ROS_PACKAGE_PATH` environment variable (better if you add the export line to your .bashrc file)
3. Add the path where you cloned ORB-SLAM to the `ROS_PACKAGE_PATH` environment variable. To do this, modify your .bashrc and add at the bottom the following line (replace PATH_TO_PARENT_OF_ORB_SLAM):

export ROS_PACKAGE_PATH=${ROS_PACKAGE_PATH}:PATH_TO_PARENT_OF_ORB_SLAM

4. Build g2o. Go into `Thirdparty/g2o/` and execute:

Expand All @@ -80,7 +82,7 @@ It only depends on OpenCV, but it should be included in the ROS distribution.
cmake .. -DCMAKE_BUILD_TYPE=Release
make

*Tip: To achieve the best performance in your computer, set your favorite compilation flags in line 97 and 98 of* `Thirdparty/g2o/CMakeLists.txt`
*Tip: To achieve the best performance in your computer, set your favorite compilation flags in line 61 and 62 of* `Thirdparty/g2o/CMakeLists.txt`
(by default -03 -march=native)

5. Build DBoW2. Go into Thirdparty/DBoW2/ and execute:
Expand Down

0 comments on commit fbcb658

Please sign in to comment.