Skip to content

Commit

Permalink
add Projects Description to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
UmbrellaLeaf5 committed May 9, 2024
1 parent a1587ec commit 556d9d7
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,29 @@

**Project of four first grade MIPT DAFE/RSE students (for engineering practical work in the second semester) in Qt C++**

## [Documentation](https://umbrellaleaf5.github.io/locus_no_pilotus/index.html)
Project's [documentation](https://umbrellaleaf5.github.io/locus_no_pilotus/index.html) generated with Doxygen with [convenient CSS theme](#used-libs-and-packages).

## Contents
* [Documentation](https://umbrellaleaf5.github.io/locus_no_pilotus/index.html "documentation generated with doxygen")
* [Description](#description)
* [Installation and configuring](#installation-and-configuring "with using MSYS")
* [Used libs and packages](#used-libs-and-packages "we are using GitHub submodules feature 😎")
* [Authors](#authors "the best guys")

### Description
\

In this project, we are developing an application that calculates the trajectory of a flying delivery robot that collects valuable cargo from control points: **Targets**.
On its way, it may encounter high mountains that it cannot fly over: **Hills**; or elliptical territories that are impossible to visit due to climate conditions: **TrappyCircles**.
Also, through some control points, the robot is simply unable to move, as the cargo may not be ready for transportation at that time, these are **TrappyLines**.

The robot's trajectory is calculated using several mathematical algorithms: [...].
The graphical interface for constructing the trajectory was created using [Qt](#used-libs-and-packages) and [QCustomPlot](#used-libs-and-packages).

In the application, you can add objects using window forms, interact with the trajectory calculation plot using the mouse cursor, create and open files in ```.json``` format with a specific style for this application. Editing objects can also be done with cursors or using a special dynamic input field with tables, opened in a separate window mode or embedded in the main one.

*We strongly recommend that you install our application using the instructions below and try it out!*

### Installation and configuring

#### On Windows 64 bit system
Expand Down

0 comments on commit 556d9d7

Please sign in to comment.