readme et diagramme UML

doc/README.md

@@ -0,0 +1,53 @@
+# Projet cpp pré-vap JIN
+
+## Auteurs
+- Antoine Pommiers
+- Clément Barthélemy
+
+## __Principe du jeu__
+Thème de la jam : "L'Agriculture la pire erreur de l'humanité ?" \
+Notre raisonnnement : Vraiment un sujet de philo, c'est une question, on peut en faire une disseration. \
+### Notre idée :
+- Jeu de ryhtme type osu!mania (mais juste 3 touches de piano)
+- Musique procédurale
+- Temps limité, 5min
+- Une disseration sur le thème de la jam s'écrit pendant qu'on joue
+- Si on est dans le rythme, des bons arguments s'écrivent. Si non, des mauvais arguments
+- Difficulté adaptative, patterne plus complexes à mesure qu'on se rapproche de la fin
+- But : Avoir la disseration parfaite, et être bon pour découvrir des nouveaux pattern de rythme
+
+## TODO 
+- [X] Génération de musique procédurale
+- [X] Prototype sans graphismes, sans Difficulté adaptative
+- [X] Beau graphismes de base (background, tiles...)
+- [X] Difficulté adaptative
+- [X] Ajout juice 
+
+## Contrôles
+
+flèches gauche, haute, et droite sur le clavier
+
+## Infos pour build
+Testé sur linux et windows visual studio.
+Avec build dans RythmGame/SimpleGame/out/build \
+Sur linux : 
+```bash
+cd SimpleGame
+mkdir out
+cd out
+mkdir build
+cd build
+cmake ../..
+make
+chmod +x src/simpleGame (dans build, donc c'est truc_avant/build/src/simpleGame)
+cd src
+./SimpleGame 
+```
+Sur Windows :
+voir la procédure [Construire un projet C++ avec cmake](https://www-inf.telecom-sudparis.eu/COURS/CSC4526/new_site/Supports/Documents/OutilsCSC4526/outilsCSC4526.html#construire-un-projet-c-avec-cmake)
+
+## Autres infos
+
+Il faut lancer SimpleGame depuis out/build/src (donc bien cd avant, sinon il y a des problèmes de path)
+compile_commands.json est crée dans out/build, dans RythmGame/SimpleGame/src c'est un lien symbolique
+