Skip to content

Commit

Permalink
Improve the Cartographer documentation. (#17)
Browse files Browse the repository at this point in the history
Cartographer itself is not the ROS integration component.
Also adds a link to the cartographer_ros repository.
  • Loading branch information
wohe committed Aug 29, 2016
1 parent c28fcc7 commit 83faf92
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 19 deletions.
10 changes: 2 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,6 @@
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
============
Expand All @@ -27,10 +22,9 @@ 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.
and mapping `SLAM`_ across multiple platforms and sensor configurations.

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

Documentation
Expand Down
18 changes: 7 additions & 11 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,6 @@
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
============
Expand All @@ -26,19 +21,20 @@ Cartographer
:hidden:

`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.
and mapping `SLAM`_ across multiple platforms and sensor configurations.

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

Getting Started with ROS
========================

You will find complete documentation for using Cartographer with ROS at `our
Read the Docs site`_.
ROS integration is provided by the `Cartographer ROS repository`_. You will find
complete documentation for using Cartographer with ROS at the
`Cartographer ROS Read the Docs site`_.

.. _our Read the Docs site: https://google-cartographer-ros.readthedocs.io
.. _Cartographer ROS repository: https://github.com/googlecartographer/cartographer_ros
.. _Cartographer ROS Read the Docs site: https://google-cartographer-ros.readthedocs.io

Getting Started without ROS
===========================
Expand Down

0 comments on commit 83faf92

Please sign in to comment.