diff --git a/README.md b/README.md index 8330fb5b58d72e417ef5cac3b0cb2c3809236d4b..7f700286d54f1e3ee7ee9bbb32cdafb7d401a067 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,33 @@ -# Projet -Modèle basique de projet gradle pour interface graphique avec `swing`. +# 2D Games engines and Pong game implementation -Les commandes gradle les plus utiles : + -- `gradle test` pour lancer les tests, -- `gradle run` pour lancer le programme, -- `gradle shadowJar` pour construire un `jar` dans `build/libs`. -- `gradle checkStyleMain` pour vérifier le style du code principal avec l'outil [checkstyle](https://checkstyle.sourceforge.io/) (rapports dans `build/reports/checkstyle/`). -- `gradle checkStyleTest` pour vérifier le style du code de test avec l'outil [checkstyle](https://checkstyle.sourceforge.io/) (rapports dans `build/reports/checkstyle/`). -- `gradle jacocoTestReport` pour lancer la couverture de code via l'outil [Jacoco](https://www.eclemma.org/jacoco/) (rapports dans `build/reports/jacoco/`). -- `gradle spotbugsMain` pour vérifier la présence de bugs dans le code principal avec l'outil [SpotBugs](https://spotbugs.github.io/) (rapports dans `reports/spotbugs/main/spotbugs.html`). -- `gradle spotbugsTest` pour vérifier la présence de bugs dans le code de test avec l'outil [SpotBugs](https://spotbugs.github.io/) (rapports dans `reports/spotbugs/test/spotbugs.html`). -- `gradle pmdMain` pour faire l'analyse statique du code principal avec l'outil [PMD](https://pmd.github.io/) (rapports dans `reports/pmd`). -- `gradle pmdTest` pour faire l'analyse statique du code de test avec l'outil [PMD](https://pmd.github.io/) (rapports dans `reports/pmd`). +As part of a university project, a group of six students developed a 2D video game engine and implemented the game Pong. This work is the result of seven intense weeks during which we worked tirelessly day and night, following agile methods, particularly Scrum, and adhering to various software engineering principles. -Le fichier `build.gradle` contient la configuration du projet avec notamment la définition de la classe contenant la méthode `main` à exécuter pour l'application. -Le projet est configuré (via le fichier `.gitlab-ci.yml`) pour produire un jar et lancer les tests sur le serveur à chaque *push*. -## Auteurs -- KOSSIVI Kossi -- AUGIER Yoann -- MEDEDJI Setondji -- ALHAJJ Fayez -- BOUALEM Maria -- BELOUAHCHI Nomane -## Copyrights +## Installation +You can run the programme with gradle so you need to have gradle installed on your machine. There is a [link](https://docs.gradle.org/current/userguide/installation.html) to a tutoriel on how to install and use gradle. + +After that, you can run the Pong game with: +```bash + gradle run +``` +This command will start the game. Now you can enjoy your party. + +## Authors +Aix Marseille University students +- [ALHAJJ Fayez](https://etulab.univ-amu.fr/a23025807) +- [AUGIER Yoann](https://etulab.univ-amu.fr/a18010750) +- [BELOUAHCHI Nomane](https://etulab.univ-amu.fr/b23024299) +- [BOUALEM Maria](https://etulab.univ-amu.fr/b23022363) +- [KOSSIVI Kossi](https://etulab.univ-amu.fr/k19021431) +- [MEDEDJI Setondji](https://etulab.univ-amu.fr/m19025211) + + +## Tech Stack + +Java, JavaSwing, JUnit -Image provenant de [Larry Ewing](lewing@isc.tamu.edu) and The GIMP \ No newline at end of file