cu-droplet-sim (README UNDER CONSTRUCTION)

Simulator for the Droplet Swarm Robotics Platform

Table of Contents

1. Installation and Build Guide
   1. Supported Platforms
   2. Dependencies
   3. Build
2. Documentation
3. Programming Guide
4. Troubleshooting
5. Droplet Robot Code
6. License

Installation and Build Guide

Supported Platforms

Microsoft Windows is currently the only supported platform for this simulator, although the source code for the library itself is platform agnostic.

Dependencies

To build the simulator you will need the following tools:

1. Microsoft Visual Studio 2010 Pro: If you are a student or associated with any academic institution and have an '@edu' email address you can get VS 2010 for free from https://www.dreamspark.com/ .
2. Qt v4.8.5: The installer you are looking for is called 'qt-win-opensource-4.8.5-vs2010.exe'. It is highly recommended that you use the default install location for Qt.
3. (Optional) Doxygen: If you want to generate your own documentation.

Build

VS 2010 solution file location.

Documentation

PDF is available in the ./docs folder. HTML documentation is hosted here.

Programming Guide

Fill out empty class definitions in ./DropletPrograms folder.

Troubleshooting

Droplet Robot Code

If you are looking for the actual robot code for the Droplet Platform is can be found at this GitHub Repository: https://github.com/correlllab/cu-droplet

License

This work is available under a Creative Commons Attribution-NonCommercial-ShareAlike License.