Readme.md

README.md

@@ -1 +1,43 @@
-# BatCube
+# BatCube
+
+A fast game where you are pursued by a ghost, you must escape level by finding buttons in sending waves of the good frequency (when there is a colored cylinder, there is a button / window with the same color in the room), Buttons will allow you to open door and escape level. You have a limit of wave to send, you can reload waves with blue plug. Two level are available for this game.
+
+This game was made with [Unity](https://unity3d.com/) during the [Global Game Jam 2017](https://globalgamejam.org/2017/games) by the [Tarkiflettes](https://github.com/Tarkiflettes) team.
+
+Global Game Jam 2017 - Waves
+
+* [Global Game Jam 2017 - Alencon](https://globalgamejam.org/2017/jam-sites/ggj-alen%C3%A7on-startech61)
+* [ouest-france](https://www.ouest-france.fr/normandie/alencon-61000/alencon-ils-creent-un-jeu-video-en-48-heures-4750244)
+
+## Controls
+
+* Mouse: Rotate character
+* z, q, s, d: Move
+* r: Reload
+* Space: Jump
+* Left click: Send waves
+* Scroll wheel: Change frequency
+
+## Installation
+
+Get the [latest version](https://github.com/Tarkiflettes/BatCube/releases) from the releases section.
+
+## Screenshot
+
+![BatCube](https://i.imgur.com/NuiHoEh.png)
+![BatCube](https://i.imgur.com/Y8Uzd5H.png)
+![BatCube](https://i.imgur.com/PkA5fXN.png)
+![BatCube](https://i.imgur.com/JbTROGQ.png)
+
+## Authors
+
+* **Lionel Jouin** - [LionelJouin](https://github.com/LionelJouin)
+* **Antoine Lambert** - [OctocatPower](https://github.com/OctocatPower)
+* **Thomas Raineau** - [Tynyndil](https://github.com/Tynyndil)
+* **Matthieu Le Biavant** - [Assassange](https://github.com/Assassange)
+
+See also the list of [contributors](https://github.com/Tarkiflettes/BatCube/graphs/contributors) who participated in this project.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details