12345qiupeng
/
cartographer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve the Cartographer documentation. (#17) 

Cartographer itself is not the ROS integration component.
Also adds a link to the cartographer_ros repository.
master
Wolfgang Hess 2016-08-29 10:23:27 +02:00 committed by GitHub
parent c28fcc7152
commit 83faf925c0
2 changed files with 9 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.rst
View File

@ -12,11 +12,6 @@
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. 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 Cartographer
============ ============
@ -27,10 +22,9 @@ Purpose
======= =======
`Cartographer`_ is a system that provides real-time simultaneous localization `Cartographer`_ is a system that provides real-time simultaneous localization
and mapping `SLAM`_ across multiple platforms and sensor configurations. This and mapping `SLAM`_ across multiple platforms and sensor configurations.
project provides Cartographer's ROS integration.
.. _Cartographer: http://www.github.com/googlecartographer/cartographer .. _Cartographer: https://github.com/googlecartographer/cartographer
.. _SLAM: http://en.wikipedia.org/wiki/Simultaneous_localization_and_mapping .. _SLAM: http://en.wikipedia.org/wiki/Simultaneous_localization_and_mapping
Documentation Documentation

18
docs/source/index.rst
View File

@ -12,11 +12,6 @@
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. 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 Cartographer
============ ============
@ -26,19 +21,20 @@ Cartographer
:hidden: :hidden:
`Cartographer`_ is a system that provides real-time simultaneous localization `Cartographer`_ is a system that provides real-time simultaneous localization
and mapping `SLAM`_ across multiple platforms and sensor configurations. This and mapping `SLAM`_ across multiple platforms and sensor configurations.
project provides Cartographer's ROS integration.
.. _Cartographer: http://www.github.com/googlecartographer/cartographer .. _Cartographer: https://github.com/googlecartographer/cartographer
.. _SLAM: http://en.wikipedia.org/wiki/Simultaneous_localization_and_mapping .. _SLAM: http://en.wikipedia.org/wiki/Simultaneous_localization_and_mapping
Getting Started with ROS Getting Started with ROS
======================== ========================
You will find complete documentation for using Cartographer with ROS at `our ROS integration is provided by the `Cartographer ROS repository`_. You will find
Read the Docs site`_. 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 Getting Started without ROS
=========================== ===========================