diff --git a/README.md b/README.md index 8dc5a6c..103157e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,46 @@ -# SAE11_2022 +# Jeu de paires +Ce jeu de paires a été développé dans le cadre de la [SAÉ1.01 "Implémentation d'un besoin client"](http://www.iut-fbleau.fr/sitebp/pt11/11_2022/BOV12CD32HOD7GJ5.php) lors de notre première année (2022) de BUT Informatique à l'IUT de Fontainebleau. +## Lancement du programme +### Compilation +> Installer au préalable les [dépendances nécessaires](#dépendances) au fonctionnement du programme + +Utiliser la commande suivante pour compiler le programme : +```bash +make +``` + +### Lancement +#### Méthode n°1 (recommandée) : Compiler et lancer le programme avec Make +Utiliser la commande suivante pour compiler (si ce n'est pas déjà) fait puis lancer le programme : +```bash +make run +``` + +#### Méthode n°2 : Compiler puis lancer le programme +Une fois la [compilation du programme](#compilation) faite, exécuter le programme à l'aide de la commande suivante : +```bash +./game +``` + +## Fonctionnalités + +### Fonctionnalités exigées + - Retournement des cartes par un clic de souris. + - Affichage du temps (en secondes) écoulé depuis le début de la partie. + - Jouer sur des grilles de tailles différentes. + - Le temps de mémorisation d'une paire de cartes découvertes dure une seconde. + - Un mode tricheur est accessible en pressant la touche `t` qui découvre la grille et interrompt le temps jusqu'à ce qu'on rappuie sur cette même touche pour reprendre la partie. + +### Fonctionnalités additionnelles + - Affichage du temps en secondes **et en minutes** + - Compteur de coups + +## Dépendances +### Bibliothèque graphique de l'IUT de Fontainebleau +Documentation : http://www.iut-fbleau.fr/sitebp/doc/doc_bib_graphique/ +Auteur : Denis Monnerat (@monnerat) + +## Crédits + - Recherche des images : @moguljak + - Code : @moguljak et @souidi