README

What is this repository for?

• Flatland is a performance centric 2d robot simulator
• Roadmap on trello
• Release Version: None

How do I get set up?

• Git clone flatland into your catkin workspace’s src folder, and catkin build.
• Optionally check out turtlebot_flatland and run the turtlebot nav stack
• Run rosdep install --from-paths src --ignore-src in your catkin workspace to install any missing rosdeps

Who do I talk to?

• Please direct any questions to @josephduchesne

Documentation

• How to use: http://flatland-simulator.readthedocs.io
• Doxygen: http://flatland-simulator-api.readthedocs.io
• For a quick start use: https://github.com/avidbots/turtlebot_flatland

License

All Flatland code is BSD 3-clause licensed (see LICENSE for details)

Flatland uses a number of open source libraries that it includes in its source tree:

• ThreadPool Copyright (c) 2012 Jakob Progsch, Václav Zeman (zlib license)
• Tweeny Copyright (c) 2016 Leonardo Guilherme de Freitas (MIT license)
• Box2d Copyright (c) 2006-2017 Erin Catto http://www.box2d.org (zlib license)

Contribution guidelines

• code should be unit tested using gtest/rosunit when practical.
• code must be formatted as per clang-format-3.8 –style=file
• code must pass clang-tidy-3.8