Project Shodrone

1. Description of the Project

This project aims to be a solution to help manage customized drone multimedia shows, provided by Shodrone.

2. Planning and Technical Documentation

The documentation is located in the "docs" folder, organized by user story, along with the global artifacts.

3. How to Build the Simulator

Build the simulator by executing the following command in the project root:

. build-simulator.sh

This script will copy the simulator executable file, called "main", to the project root. This executable can be taken anywhere (Linux only) and used; however, the figure scripts provided by the user need to be in the same directory of the executable file (next to it). After the simulation finishes, the "reports" directory is created next to the executable file, which contains the simulation report.

4. How to Run the Simulator

Run the simulator by executing the following command in the project root:

. run-simulator.sh

The figure scripts must be provided in the project root. The simulation report will be there too after running the simulator, in the "reports" directory.

5. How to Generate PlantUML Diagrams

To generate plantuml diagrams for documentation, execute the following script:

• For Windows:

  ./generate-plantuml-diagrams.bat

• For Linux/Unix-based systems:

  ./generate-plantuml-diagrams.sh