From 7a70ef92a6bbb8dc317062cfa593a62bba675e85 Mon Sep 17 00:00:00 2001 From: Damon Kohler Date: Tue, 11 Oct 2016 15:48:27 +0200 Subject: [PATCH] Improves documentation. (#97) * Adds system requirements to the documentation. * References our mailing list. --- README.rst | 10 +++++----- docs/source/index.rst | 24 ++++++++++++++++-------- 2 files changed, 21 insertions(+), 13 deletions(-) diff --git a/README.rst b/README.rst index 0e8b0e0..2836ed5 100644 --- a/README.rst +++ b/README.rst @@ -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% diff --git a/docs/source/index.rst b/docs/source/index.rst index ca6622c..04690a6 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -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 `_ and -`rosdep `_. For faster builds, we also recommend -using `Ninja `_. +We recommend using `wstool `_ and `rosdep +`_. For faster builds, we also recommend using +`Ninja `_. .. code-block:: bash @@ -64,8 +72,8 @@ using `Ninja `_. 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