61 lines
2.0 KiB
ReStructuredText
61 lines
2.0 KiB
ReStructuredText
.. 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 documentation master file, created by
|
|
sphinx-quickstart on Fri Jul 8 10:41:33 2016.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
============
|
|
Cartographer
|
|
============
|
|
|
|
|build| |docs|
|
|
|
|
Purpose
|
|
=======
|
|
|
|
`Cartographer`_ is a system that provides real-time simultaneous localization
|
|
and mapping `SLAM`_ across multiple platforms and sensor configurations. This
|
|
project provides Cartographer's ROS integration.
|
|
|
|
.. _Cartographer: http://www.github.com/googlecartographer/cartographer
|
|
.. _SLAM: http://en.wikipedia.org/wiki/Simultaneous_localization_and_mapping
|
|
|
|
Documentation
|
|
=============
|
|
|
|
You will find complete documentation for using Cartographer at `our Read the
|
|
Docs site`_.
|
|
|
|
.. _our Read the Docs site: https://google-cartographer.readthedocs.io
|
|
|
|
Contributing
|
|
============
|
|
|
|
You can find information about contributing to Cartographer at our `Contribution
|
|
page`_.
|
|
|
|
.. _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
|