Go to file
Damon Kohler 4e9c3d69b5 Build all our source files into a single library. (#164) 2016-12-20 11:24:08 +01:00
cartographer Build all our source files into a single library. (#164) 2016-12-20 11:24:08 +01:00
cmake Build all our source files into a single library. (#164) 2016-12-20 11:24:08 +01:00
configuration_files Remove the 'log_residual_histograms' option. (#166) 2016-12-19 17:57:12 +01:00
docs Fix documentation and Docker cache. (#157) 2016-12-09 13:08:43 +01:00
scripts Build all our source files into a single library. (#164) 2016-12-20 11:24:08 +01:00
.dockerignore Add Xenial to build matrix. (#156) 2016-12-09 10:57:41 +01:00
.gitignore Add .gitignore to hide the "build" directory (#40) 2016-10-10 18:07:48 +02:00
.travis.yml Fix documentation and Docker cache. (#157) 2016-12-09 13:08:43 +01:00
AUTHORS Initial import of Cartographer codebase. 2016-08-02 09:12:42 +02:00
CMakeLists.txt Build all our source files into a single library. (#164) 2016-12-20 11:24:08 +01:00
CONTRIBUTING.md Initial import of Cartographer codebase. 2016-08-02 09:12:42 +02:00
Dockerfile.trusty Add Xenial to build matrix. (#156) 2016-12-09 10:57:41 +01:00
Dockerfile.xenial Add Xenial to build matrix. (#156) 2016-12-09 10:57:41 +01:00
LICENSE Initial import of Cartographer codebase. 2016-08-02 09:12:42 +02:00
README.rst Add License badge. (#163) 2016-12-19 09:19:15 +01:00
cartographer-config.cmake.in Fix link dependencies. (#159) 2016-12-12 14:56:54 +01:00
package.xml Switch to new ceres-solver package. (#139) 2016-11-22 16:33:14 +01:00

README.rst

.. Copyright 2016 The Cartographer Authors

.. Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

..      http://www.apache.org/licenses/LICENSE-2.0

.. Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

============
Cartographer
============

|build| |docs| |license|

Purpose
=======

`Cartographer`_ is a system that provides real-time simultaneous localization
and mapping (`SLAM`_) in 2D and 3D across multiple platforms and sensor
configurations.

|video|

.. _Cartographer: https://github.com/googlecartographer/cartographer
.. _SLAM: https://en.wikipedia.org/wiki/Simultaneous_localization_and_mapping

Getting started
===============

* Learn to use Cartographer at `our Read the Docs site`_.
* Please join the `mailing list`_ and ask questions.

.. _our Read the Docs site: https://google-cartographer.readthedocs.io
.. _mailing list: https://groups.google.com/forum/#!forum/google-cartographer

Contributing
============

You can find information about contributing to Cartographer at `our Contribution
page`_.

.. _our Contribution page: https://github.com/googlecartographer/cartographer/blob/master/CONTRIBUTING.md

.. |build| image:: https://travis-ci.org/googlecartographer/cartographer.svg?branch=master
    :alt: Build Status
    :scale: 100%
    :target: https://travis-ci.org/googlecartographer/cartographer
.. |docs| image:: https://readthedocs.org/projects/google-cartographer/badge/?version=latest
    :alt: Documentation Status
    :scale: 100%
    :target: https://google-cartographer.readthedocs.io/en/latest/?badge=latest
.. |license| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
     :alt: Apache 2 license.
     :scale: 100%
     :target: https://github.com/googlecartographer/cartographer/blob/master/LICENSE
.. |video| image:: https://j.gifs.com/wp3BJM.gif
    :alt: Cartographer 3D SLAM Demo
    :scale: 100%
    :target: https://youtu.be/DM0dpHLhtX0