2016-08-25 21:16:33 +08:00
|
|
|
.. 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 ROS Integration
|
|
|
|
|
============================
|
|
|
|
|
|
2016-08-30 14:33:45 +08:00
|
|
|
|build| |docs|
|
2016-08-25 21:16:33 +08:00
|
|
|
|
|
|
|
|
Purpose
|
|
|
|
|
=======
|
|
|
|
|
|
|
|
|
|
`Cartographer`_ is a system that provides real-time simultaneous localization
|
2016-10-05 23:27:21 +08:00
|
|
|
and mapping (`SLAM`_) in 2D and 3D across multiple platforms and sensor
|
2016-10-04 21:39:54 +08:00
|
|
|
configurations. This project provides Cartographer's ROS integration.
|
2016-08-25 21:16:33 +08:00
|
|
|
|
2016-08-30 22:12:32 +08:00
|
|
|
.. _Cartographer: https://github.com/googlecartographer/cartographer
|
|
|
|
|
.. _SLAM: https://en.wikipedia.org/wiki/Simultaneous_localization_and_mapping
|
2016-08-25 21:16:33 +08:00
|
|
|
|
2016-10-11 21:48:27 +08:00
|
|
|
Getting started
|
|
|
|
|
===============
|
2016-08-25 21:16:33 +08:00
|
|
|
|
2016-10-11 21:48:27 +08:00
|
|
|
* Learn to use Cartographer with ROS at `our Read the Docs site`_.
|
|
|
|
|
* Please join the `mailing list`_ and ask questions.
|
2016-08-25 21:16:33 +08:00
|
|
|
|
|
|
|
|
.. _our Read the Docs site: https://google-cartographer-ros.readthedocs.io
|
2016-10-11 21:48:27 +08:00
|
|
|
.. _mailing list: https://groups.google.com/forum/#!forum/google-cartographer
|
2016-08-25 21:16:33 +08:00
|
|
|
|
|
|
|
|
Contributing
|
|
|
|
|
============
|
|
|
|
|
|
|
|
|
|
You can find information about contributing to Cartographer's ROS integration
|
2016-10-04 21:39:54 +08:00
|
|
|
at `our Contribution page`_.
|
2016-08-25 21:16:33 +08:00
|
|
|
|
2016-10-04 21:39:54 +08:00
|
|
|
.. _our Contribution page: https://github.com/googlecartographer/cartographer_ros/blob/master/CONTRIBUTING.md
|
2016-08-25 21:16:33 +08:00
|
|
|
|
2016-08-30 14:33:45 +08:00
|
|
|
.. |build| image:: https://travis-ci.org/googlecartographer/cartographer_ros.svg?branch=master
|
|
|
|
|
:alt: Build Status
|
|
|
|
|
:scale: 100%
|
|
|
|
|
:target: https://travis-ci.org/googlecartographer/cartographer_ros
|
2016-08-25 21:16:33 +08:00
|
|
|
.. |docs| image:: https://readthedocs.org/projects/google-cartographer-ros/badge/?version=latest
|
|
|
|
|
:alt: Documentation Status
|
|
|
|
|
:scale: 100%
|
|
|
|
|
:target: https://google-cartographer-ros.readthedocs.io/en/latest/?badge=latest
|
