README.rst 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. .. Copyright 2016 The Cartographer Authors
  2. .. Licensed under the Apache License, Version 2.0 (the "License");
  3. you may not use this file except in compliance with the License.
  4. You may obtain a copy of the License at
  5. .. http://www.apache.org/licenses/LICENSE-2.0
  6. .. Unless required by applicable law or agreed to in writing, software
  7. distributed under the License is distributed on an "AS IS" BASIS,
  8. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  9. See the License for the specific language governing permissions and
  10. limitations under the License.
  11. ============================
  12. Cartographer ROS Integration
  13. ============================
  14. |build| |docs| |license|
  15. Purpose
  16. =======
  17. `Cartographer`_ is a system that provides real-time simultaneous localization
  18. and mapping (`SLAM`_) in 2D and 3D across multiple platforms and sensor
  19. configurations. This project provides Cartographer's ROS integration.
  20. .. _Cartographer: https://github.com/googlecartographer/cartographer
  21. .. _SLAM: https://en.wikipedia.org/wiki/Simultaneous_localization_and_mapping
  22. Getting started
  23. ===============
  24. * Learn to use Cartographer with ROS at `our Read the Docs site`_.
  25. * You can ask a question by `creating an issue`_.
  26. .. _our Read the Docs site: https://google-cartographer-ros.readthedocs.io
  27. .. _creating an issue: https://github.com/googlecartographer/cartographer_ros/issues/new?labels=question
  28. Contributing
  29. ============
  30. You can find information about contributing to Cartographer's ROS integration
  31. at `our Contribution page`_.
  32. .. _our Contribution page: https://github.com/googlecartographer/cartographer_ros/blob/master/CONTRIBUTING.md
  33. .. |build| image:: https://travis-ci.org/googlecartographer/cartographer_ros.svg?branch=master
  34. :alt: Build Status
  35. :scale: 100%
  36. :target: https://travis-ci.org/googlecartographer/cartographer_ros
  37. .. |docs| image:: https://readthedocs.org/projects/google-cartographer-ros/badge/?version=latest
  38. :alt: Documentation Status
  39. :scale: 100%
  40. :target: https://google-cartographer-ros.readthedocs.io/en/latest/?badge=latest
  41. .. |license| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
  42. :alt: Apache 2 license.
  43. :scale: 100%
  44. :target: https://github.com/googlecartographer/cartographer_ros/blob/master/LICENSE