Merge branch 'readme' into 'master'

update README

See merge request mhart/DancingDroids!76
This commit is contained in:
Martin HART 2020-11-08 23:12:56 +01:00
commit ba488718b9
1 changed files with 10 additions and 3 deletions

View File

@ -5,9 +5,16 @@
## 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 they finish all instructions or there's a collision between two of them or between a robot and the edge of the map. \
The aim is to display a grid with robots moving in it, until:
- they finish all instructions
- they collide
- a robot goes off 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)
If you leave some instruction lines blank, they will be generated for you. \
You can find more information in the [subject](https://framagit.org/mhart/DancingDroids/-/blob/master/SUBJECT.md).
## Flags
@ -27,4 +34,4 @@ You can find more information in the [subject](https://framagit.org/mhart/Dancin
## Disclaimer
In order to read the code of this project you need to use sunglasses.
Please, make sure you keep breathing.
Please, make sure you keep breathing :heart: