Improves documentation. (#97)

* Adds system requirements to the documentation.
* References our mailing list.
master
Damon Kohler 2016-10-11 15:48:27 +02:00 committed by GitHub
parent 61183d5dbc
commit 7a70ef92a6
2 changed files with 21 additions and 13 deletions

View File

@ -28,13 +28,14 @@ configurations. This project provides Cartographer's ROS integration.
.. _Cartographer: https://github.com/googlecartographer/cartographer
.. _SLAM: https://en.wikipedia.org/wiki/Simultaneous_localization_and_mapping
Documentation
=============
Getting started
===============
You will find complete documentation for using Cartographer with ROS at `our
Read the Docs site`_.
* Learn to use Cartographer with ROS at `our Read the Docs site`_.
* Please join the `mailing list`_ and ask questions.
.. _our Read the Docs site: https://google-cartographer-ros.readthedocs.io
.. _mailing list: https://groups.google.com/forum/#!forum/google-cartographer
Contributing
============
@ -48,7 +49,6 @@ at `our Contribution page`_.
:alt: Build Status
:scale: 100%
:target: https://travis-ci.org/googlecartographer/cartographer_ros
.. |docs| image:: https://readthedocs.org/projects/google-cartographer-ros/badge/?version=latest
:alt: Documentation Status
:scale: 100%

View File

@ -30,16 +30,24 @@ configurations. This project provides Cartographer's ROS integration.
.. _Cartographer: https://github.com/googlecartographer/cartographer
.. _SLAM: https://en.wikipedia.org/wiki/Simultaneous_localization_and_mapping
.. _getting-started:
System Requirements
===================
Although Cartographer ROS may run on other systems, it is confirmed to be
working on systems that meet the following requirements:
* 64-bit, modern CPU (e.g. 3rd generation i7)
* 16 GB RAM
* Ubuntu 14.04 (Trusty)
* gcc version 4.8.4
* ROS Indigo
Building & Installation
=======================
Installation has been tested on Ubuntu 14.04 (Trusty) with ROS Indigo, but may
also work on Ubuntu 16.04 (Xenial) with ROS Kinetic. We recommend using
`wstool <http://wiki.ros.org/wstool>`_ and
`rosdep <http://wiki.ros.org/rosdep>`_. For faster builds, we also recommend
using `Ninja <https://ninja-build.org>`_.
We recommend using `wstool <http://wiki.ros.org/wstool>`_ and `rosdep
<http://wiki.ros.org/rosdep>`_. For faster builds, we also recommend using
`Ninja <https://ninja-build.org>`_.
.. code-block:: bash
@ -64,8 +72,8 @@ using `Ninja <https://ninja-build.org>`_.
catkin_make_isolated --install --use-ninja
source install_isolated/setup.bash
Running the demo
================
Running the demos
=================
Now that Cartographer and Cartographer's ROS integration are installed,
download the example bags (e.g. 2D and 3D backpack collections of the