From 4f0b62d977bf4b3420f59a45b771a63354db4151 Mon Sep 17 00:00:00 2001 From: Leopold Clement Date: Sun, 18 Jul 2021 17:00:14 +0200 Subject: [PATCH] Correction de la doc --- docs/archi.md | 8 ++++---- docs/bitmap.md | 10 +++++----- docs/class.md | 18 +++++++++--------- docs/index.md | 8 ++++---- docs/joystick.md | 2 +- docs/lcd.md | 8 ++++---- docs/led.md | 6 +++--- docs/rng.md | 4 ++-- docs/thread.md | 20 ++++++++++---------- docs/tuto.md | 10 +++++----- mkdocs.yml | 4 ++-- 11 files changed, 49 insertions(+), 49 deletions(-) diff --git a/docs/archi.md b/docs/archi.md index 2d23efa..c646fa4 100644 --- a/docs/archi.md +++ b/docs/archi.md @@ -6,13 +6,13 @@ Le programe comporte plusieurs composants. Il y a : - des queues, pour comuniquer entre les threads, - - des varriables partagées (type black board), + - des variables partagées (type black board), - - un mutex, pour gérer l'acces à l'écran + - un mutex, pour gérer l'accès à l'écran - des [classes](class.md) -- des pérriférique: +- des périphériques : - L'[écran](lcd.md) @@ -24,7 +24,7 @@ Le programe comporte plusieurs composants. Il y a : ## Diagramme des composants : -Les composants intéragicent de la manière suivante : +Les composants interagissent de la manière suivante : ![Schéma des composants](Architecture_projet.svg) ## Principales variables : diff --git a/docs/bitmap.md b/docs/bitmap.md index 5137ab9..ccd0f59 100644 --- a/docs/bitmap.md +++ b/docs/bitmap.md @@ -1,18 +1,18 @@ # Génération d'```image.h``` -Pour utilisé les bitmaps dans le code, il fait convertir les ```.bmp``` en un ```.h```. Pour cela, on utilise un script python dévelopé pour l'ocasion : ```BmpToHConvertor.py```. Il permet de composé un header comportant autant de bitmap que voulue. +Pour utiliser les bitmaps dans le code, il faut convertir les ```.bmp``` en un ```.h```. Pour celà, on utilise un script python dévelopé pour l'occasion : ```BmpToHConvertor.py```. Il permet de composer un header comportant autant de bitmaps que voulus. ## Utilisation -L'usage du script est simple, ainsi pour crée notre ```image.h```, nous avons utilisé la commande suivante : +L'usage du script est simple, ainsi pour créer notre ```image.h```, nous avons utilisé la commande suivante : ``` bash python3 BmpToHConvertor.py --HEADER_NAME Core/Inc/images --INPUT_FILE asset_brut/Coeur_E.bmp asset_brut/Coeur_F.bmp asset_brut/Joueur.bmp asset_brut/Ennemi_1.bmp asset_brut/Ennemi_2.bmp asset_brut/Ennemi_3.bmp asset_brut/Ennemi_4.bmp --VAR_NAMES tex_coeur_E tex_coeur_F tex_joueur tex_ennemi_1 tex_ennemi_2 tex_ennemi_3 tex_ennemi_4 ``` -Bien qu'elle soit longue, elle ne fait que lister les fichier d'entrés et le nom des varriables de sortie. +Bien qu'elle soit longue, elle ne fait que lister les fichiers d'entrée et le nom des variables de sortie. ## Contrainte sur les images -Pour que les images soit compatibles, il faut que elles soit enregistre avec un codage ```R5G6B5``` sur 16 bits. De plus, il ne faut pas utiliser de pallette de couleur. +Pour que les images soit compatibles, il faut que elles soient enregistrées avec un codage ```R5G6B5``` sur 16 bits. De plus, il ne faut pas utiliser de pallette de couleur. !!! info - Il faut absolument que l'image ais une largeure multiple de 4, sinon un bug d'affichage déformant l'image se produit. \ No newline at end of file + Il faut absolument que l'image ait une largeur multiple de 4, sinon un bug d'affichage déformant l'image se produit. \ No newline at end of file diff --git a/docs/class.md b/docs/class.md index 45bc590..8e2c44c 100644 --- a/docs/class.md +++ b/docs/class.md @@ -1,23 +1,23 @@ -# Classe +# Classes Les classes utilisées sont les suivantes : ![Diagramme de classes](class.svg) -## Classe de representation +## Classe de représentation -Pour representer les élements dans le jeu, on utilise les classes : +Pour représenter les éléments dans le jeu, on utilise les classes : -- ```Joueur``` qui n'est instancier qu'une seule fois, et qui represente le joueur, +- ```Joueur``` qui n'est instanciée qu'une seule fois, et qui représente le joueur, -- ```Monster``` qui represente les monstres, +- ```Monster``` qui représente les monstres, -- ```Missile``` qui represente les projectiles. +- ```Missile``` qui représente les projectiles. -Des instances de la classe ```Missile``` sont memebres des deux autres classes car elles representent les projeciles de basse. +Des instances de la classe ```Missile``` sont membres des deux autres classes car elles représentent les projectiles de base. -De plus, les threads ```Joueur_1``` et ```Block_Enemie``` envoie des objet ```Missile``` dans la ```queue_N``` vers le thread ```Projectile``` pour lui signaler les nouveaux missiles à simuler. +De plus, les threads ```Joueur_1``` et ```Block_Enemie``` envoient des objets ```Missile``` dans la ```queue_N``` vers le thread ```Projectile``` pour lui signaler les nouveaux missiles à simuler. ## Classe de messagerie -Les classes utiles pour les messages sont ```struct Collision``` qui peremt de transmetre toutes les informations relatives à un choc avec un monstre en même temps, et la class ```enum End_Type``` qui décrit le type de fin de vague que l'on rencontre (défaite des monstre ou du joueur). \ No newline at end of file +Les classes utiles pour les messages sont ```struct Collision``` qui permet de transmettre toutes les informations relatives à un choc avec un monstre en même temps, et la classe ```enum End_Type``` qui décrit le type de fin de vague que l'on rencontre (défaite des monstres ou du joueur). \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index cc25c13..69ae704 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ # Space Invader -Projet du second semetre de : +Projet du second semestre de : * [Léopold Clément](mailto:leopold.clement@ens-paris-saclay.fr) @@ -8,9 +8,9 @@ Projet du second semetre de : Si vous avez des difficultés avec le jeu, un tutoriel est disponible [ici](tuto.md). -Sinon, tous les détails techniques sont expliquer [ici](archi.md). +Sinon, tous les détails techniques sont expliqués [ici](archi.md). !!! info "Record de fin" - Si vous arrivé jusqu'à la vague 15, prévenez nous. + Si vous arrivez jusqu'à la vague 15, prévenez nous. -Nous remercions [Maïna Garnero](mailto:maina.garnero@ens-paris-saclay.fr), biologiste de son état, pour sa participation à la réalisation de tout les élements graphique du jeu. +Nous remercions [Maïna Garnero](mailto:maina.garnero@ens-paris-saclay.fr), biologiste de son état, pour sa participation à la réalisation de tous les éléments graphiques du jeu. diff --git a/docs/joystick.md b/docs/joystick.md index ca4c733..673dee2 100644 --- a/docs/joystick.md +++ b/docs/joystick.md @@ -1,3 +1,3 @@ # Joystick -On réaliste un seuillage autour de la valeur centrale. Le joystick n'est pas vraiment annalogique, il n'y a que 8 directions possibles. \ No newline at end of file +On réalise un seuillage autour de la valeur centrale. Le joystick n'est pas vraiment annalogique, il n'y a que 8 directions possibles. \ No newline at end of file diff --git a/docs/lcd.md b/docs/lcd.md index b9bb405..4032174 100644 --- a/docs/lcd.md +++ b/docs/lcd.md @@ -1,13 +1,13 @@ # L'écran ## Organisation de l'écran -Les dix pixel en haut de l'écran sont reservés pour l'affichage des informations. +Les dix pixels en haut de l'écran sont reservés pour l'affichage des informations. Les monstres sont rangés sur trois rangs ## Mutex -Pour ne pas aoir de problème d'interruption entre les threads pendant la manipulation de la mémoire de l'écran, on utilise un mutex ainsi que une série de fonction permetant de faire automatiquement l'attente et le relachement du mutex. +Pour ne pas avoir de problème d'interruption entre les threads pendant la manipulation de la mémoire de l'écran, on utilise un mutex ainsi qu'une série de fonctions permettant de faire automatiquement l'attente et le relachement du mutex. ## Bitmap -Toutes les textures sont stoké dans ```image.h```. Les textures des coeurs et du joueur sont utilisé dirrectement, alors que pour les 4 texture des monstres, on utilise une liste de pointeur vers les textures. Ainsi, on peut changé rapidement la texture utilisé par les monstres pour avoir des sorte d'annimation. -La generation des bitmap est abordé dans un [partie dédiée](bitmap.md). +Toutes les textures sont stokées dans ```image.h```. Les textures des coeurs et du joueur sont utilisées directement, alors que pour les 4 textures des monstres, on utilise une liste de pointeurs vers les textures. Ainsi, on peut changer rapidement la texture utilisée par les monstres pour avoir des sortes d'animation. +La génération des bitmaps est abordée dans une [partie dédiée](bitmap.md). diff --git a/docs/led.md b/docs/led.md index 2456e3b..7986740 100644 --- a/docs/led.md +++ b/docs/led.md @@ -2,9 +2,9 @@ ## Ecriture sur les LEDs -Pour facilité l'utilisation des LEDs, on utilise une liste d'objet ```struct led```, ainsi ```Leds[n] = {{LEDXX_GPIO_Port, LEDXX_Pin}}```. +Pour faciliter l'utilisation des LEDs, on utilise une liste d'objets ```struct led```, ainsi ```Leds[n] = {{LEDXX_GPIO_Port, LEDXX_Pin}}```. -On peut ainsi utilisé la ligne ```HAL_GPIO_WritePin(Leds[idx].port, Leds[idx].pin, !(charge-1