~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The Mobile Robot Programming Toolkit (MRPT) project
http://www.mrpt.org/
The Machine Perception and Intelligent Robotics Lab,
University of Malaga: http://babel.isa.uma.es/mapir/
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Contents:
1. Introduction
2. Documentation
3. Compiling and installing
3.1. Five seconds instructions
3.2. Further details
4. News (Changelog)
5. License
1. Introduction
------------------------------------------------------------------------------
The MRPT project comprises of libraries and tools aimed to help researchers
in the areas of mobile robots and computer vision in the development of
efficient implementations with reusability of code as a priority.
It includes classes for easily managing 3D(6D) geometry, probability density
functions (pdfs) over many predefined variables (points,landmarks,poses,maps,...),
Bayesian inference (Kalman filters, particle filters), image processing, obstacle
avoidance, etc...
2. Documentation
------------------------------------------------------------------------------
Further information, the latest downloads, documentation, and tutorials are
available online at the MRPT website:
http://www.mrpt.org/
The complete classes reference can be found at "doc/chm/", or online at:
http://reference.mrpt.org/
For questions on using or compiling MRPT, write in the help forums:
http://www.mrpt.org/forum-users/
3. Compiling and installing
------------------------------------------------------------------------------
3.1 *** FIVE SECONDS INSTRUCTIONS ***
Linux -> Invoke "ccmake ." at the root of the directory tree,
select 'generate', then run "make".
Windows -> Execute the appropriate script for your compiler from
those at "makefiles/win32_rebuild_XXXX.bat", select your
configuration, select 'generate' and the project for your
IDE will be generated at, for example, 'makefiles/MSVC8'.
To build the examples -> Enable "BUILD_SAMPLES" from cmake-gui.
3.2. Further details (RECOMMENDED!)
See the document "doc/COMPILE-INSTALL.html" for instructions on how to compile
the MRPT C++ library, the samples, applications, and also how to regenerate the
reference documentation. Probably a more updated version will be found at:
http://www.mrpt.org/Building_and_Installing_Instructions
See also "makefiles/README_win32.txt" and "makefiles/README_linux.txt".
4. News / Changelog
------------------------------------------------------------------------------
The last changes can be found in "doc/NEWS.html". The updated online version,
generated automatically from SVN comits, can be found at:
http://reference.mrpt.org/svn/changelog.html
5. LICENSE
------------------------------------------------------------------------------
License for the Mobile Robot Programming Toolkit (MRPT)
Copyright (C) 2005-2010 University of Malaga
This software was written by the Perception and Robotics
research group, University of Malaga (Spain).
Contact: Jose-Luis Blanco <jlblanco@ctima.uma.es>
This file is part of the MRPT project.
MRPT is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
MRPT is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with MRPT. If not, see <http://www.gnu.org/licenses/>.
