diff --git a/README.md b/README.md index 461d1e33f75e85ea900aceec6b4538fa19d4c3fa..ead8eca63b61e58ef26ce4758ee3b9fc8f8402c3 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ # MoteurDeJeu +## Documents disponible + +- Documentation sur l'architecture du moteur de jeu : [lien](doc/archiMoteurDeJeu.md) +- Documentation sur l'utilisation du moteur de jeu : [lien](doc/MoteurDeJeu.md) + +## Code source + +- Le code source se trouve dans le dossier [src](src) avec l'architecture discutée [ici](doc/archiMoteurDeJeu.md) +- Il est possible d'ouvrir le dossier à la racine directement dans [Netbeans](https://netbeans.apache.org) + +## Objectif + +- Faire un clone du moteur de jeu sur son ordinateur : +``` +git clone https://gitlab.univ-lorraine.fr/villard5/moteurdejeu.git +``` +- Compiler la bibliothèque ``moteurDeJeu.jar``` +- Faire votre jeu en utilisant cette bibliothèque +- Utiliser le [git](https://gitlab.univ-lorraine.fr/) de l'université de lorraine comme gestionnaire de version