94 lines
2.2 KiB
Markdown
94 lines
2.2 KiB
Markdown
# DorfJavaTik
|
|
|
|
Projet Saé de DEV première année deuxième semestre.
|
|
Binome : Balocchi Loris
|
|
Charpentier Juliette
|
|
|
|
DorfJavaTik est un jeu développé en Java utilisant Swing pour l'interface graphique. Ce README fournit des instructions détaillées pour compiler et exécuter le projet en utilisant le `Makefile` sous Linux.
|
|
|
|
## Prérequis
|
|
|
|
Avant de commencer, assurez-vous que les outils suivants sont installés sur votre système:
|
|
|
|
- Java Development Kit (JDK)
|
|
- `make`
|
|
|
|
Vous pouvez vérifier si Java et `make` sont installés en exécutant les commandes suivantes dans votre terminal :
|
|
|
|
```bash
|
|
java -version
|
|
javac -version
|
|
make -v
|
|
```
|
|
|
|
## Structure du projet
|
|
|
|
Le projet est organisé comme suit :
|
|
|
|
```
|
|
/src
|
|
/com
|
|
/charpentierbalocchi
|
|
/dorfjavatik
|
|
/controller
|
|
/model
|
|
/util
|
|
/view
|
|
/resources
|
|
- background.wav
|
|
- image.gif
|
|
/bin
|
|
```
|
|
|
|
## Utilisation du Makefile
|
|
|
|
Le `Makefile` inclus dans le projet offre plusieurs commandes pour faciliter la compilation, l'exécution et la gestion des fichiers de projet.
|
|
|
|
### Compilation du projet
|
|
|
|
Pour compiler le projet, naviguez dans le répertoire racine du projet et exécutez la commande suivante :
|
|
|
|
```bash
|
|
make
|
|
```
|
|
|
|
Cette commande effectue les actions suivantes :
|
|
|
|
- Nettoie le répertoire de build précédent (`bin`).
|
|
- Compile les sources Java.
|
|
- Copie les ressources nécessaires dans le répertoire de build.
|
|
|
|
### Exécution du projet
|
|
|
|
Pour exécuter le projet après la compilation, utilisez la commande :
|
|
|
|
```bash
|
|
make run
|
|
```
|
|
|
|
Cette commande lance le jeu en utilisant les fichiers compilés dans le répertoire `bin`, sans passer par un fichier `.jar`.
|
|
|
|
### Génération de la documentation
|
|
|
|
Pour générer la documentation du projet (Javadoc), exécutez la commande :
|
|
|
|
```bash
|
|
make javadoc
|
|
```
|
|
|
|
La documentation sera placée dans `bin/docs`.
|
|
|
|
### Nettoyage du projet
|
|
|
|
Pour supprimer tous les fichiers générés lors de la compilation, y compris les fichiers `.class` et la documentation, exécutez :
|
|
|
|
```bash
|
|
make clean
|
|
```
|
|
|
|
Cette commande nettoiera le répertoire `bin` en supprimant tous les fichiers et dossiers qu'il contient.
|
|
|
|
## Conclusion
|
|
|
|
Suivez ces instructions pour compiler et exécuter le projet DorfJavaTik en utilisant `make`.
|