Merge branch 'readme' into 'master'

Readme

See merge request mhart/DancingDroids!60
This commit is contained in:
Martin HART 2020-11-08 16:52:24 +01:00
commit 9b99bf25fd
1 changed files with 29 additions and 0 deletions

29
README.md Normal file
View File

@ -0,0 +1,29 @@
# DancingDroids v0.3.0
When droids dance togethers
## Description
DancingDroids is a huge pile of stinky shit that looks like a game played by your computer. \
The aim is to display a grid with robots moving in it, until there's a collision between two of them, or between a robot and the edge of the map. \
The size of the grid, robot's positions and their move are preconfigured in a file that has to be correctly formated <- Don't mess with that. \
You can find more information in the [subject](https://framagit.org/mhart/DancingDroids/-/blob/master/SUBJECT.md)
## Flags
```
-h, --help Prints help information
-V, --version Prints version information
-w, --random-world Generate random world
-f, --file <file> Configuration file
```
## Authors
- Martin HART
- Volodymyr PATUTA
- Stephane Elias BENABDESLAM
## Disclaimer
In order to read the code of this project you need to use sunglasses.
Please, make sure you keep breathing.