Commit 767d0ccd authored by Merwane Bouri's avatar Merwane Bouri
Browse files

Update README.md

parent 83bfb408
Pipeline #79698 passed with stages
in 18 seconds
......@@ -6,6 +6,8 @@ Application développée dans le cadre de l’UV LO21 permet de répondre à la
- [Pour commencer](#pour-commencer)
- [Installation](#installation)
- [Démarrage](#demarrage)
- [Détails sur l'Application](#Détails sur l'Application)
- [](#)
- [](#)
- [](#)
......@@ -14,9 +16,7 @@ Application développée dans le cadre de l’UV LO21 permet de répondre à la
- [](#)
- [](#)
- [](#)
- [](#)
- [](#)
- [Glossaire](#glossaire)
- [Auteurs et licence](#auteurs)
## Pour commencer
Avoir une version de **QtCreator** d'au moins 5.12.
......@@ -28,34 +28,42 @@ Dans votre répétoire faire: `$ git clone https://gitlab.utc.fr/lo21_pin_noir_b
## Démarrage
Dites comment faire pour lancer votre projet
Ouvrez le projet avec QtCreator, compiler et executer le programme, puis admirez **vos** automates cellulaires :)
## Détails sur l'Application
De prime abord, l’application permet à l’utilisateur de paramétrer intégralement les différents types d’**automates cellulaires** : **taille du réseau** (par réglage des dimensions de la grille), l’**ensemble des états **(nombre d’états, nom et couleur associée paramétrable directement par l’interface de l’Alphabet), le **type de voisinage** (Von Neumann, Moore, ou tout simplement arbitraire), ainsi que la règle de transition (Jeu de la vie, totalistique, etc..). L’utilisateur a également une totale liberté sur la nature des frontières de la grille : Elles peuvent être aussi bien périodiques (comme le propose le sujet) ou inertes (ajout supplémentaire).
### Alphabet
En ce qui concerne l’**Alphabet**, ce dernier permet de paramétrer jusqu’à **32 états** (supérieur aux 8 états du cahier des charges). Le nom et la couleur peuvent aussi être paramétrés. Notre application se veut également accessible à tous : En ce sens, nous avons implémenté un mode Daltonien permettant à ces derniers de pouvoir simuler jusqu’à 8 états sans aucun problème, et dont le contraste des couleurs s’adapte aux personnes souffrant de deutéranomalie.
### Voisinage
Du point de vue du **voisinage** et de la règle de transition, l’utilisateur peut à sa guise utiliser des modèles d’automate cellulaires déjà proposés par l’application, ou bien laisser part à sa créativité en créant ou modifiant des règles déjà établies : Ces nouvelles créations pourront être sauvegardées et utilisées par la suite. Une aide est accessible à l’utilisateur dans le cadre de la création de ces règles.
### Configuration initiale
Au moment de « jouer » avec la grille, l’application propose à l’utilisateur d’utiliser plusieurs structures déjà implémentées : oscillateurs, langton’s loops, etc. Quelques structures « exotiques » ont pu se glisser dans ces patterns, n’hésitez donc pas à toutes les consulter. L’utilisateur peut également paramétrer l’état initial de la grille de façon manuelle en sélectionnant simplement les cellules à modifier (un maintien du clic gauche permet de modifier rapidement un groupe de cellules).
S’il venait à l’utilisateur de devoir interrompre son chef-d’œuvre artistique, l’application sauvegarde automatiquement les différents changements (qu’ils concernent la grille ou les paramètres).
Enfin, l’utilisateur a la possibilité d’utiliser des configurations déjà établies ou d’en créer, de façon similaire aux règles de transition et de voisinage.
Lorsque la configuration de l’automate est complète, l’utilisateur peut réellement démarrer l’application avec le bouton Play. Il peut à n’importe quel instant remettre à zéro l’intégralité de la simulation, modifier à sa guise la vitesse de simulation (mode automatique), aller directement à l’état suivant, ou revenir à l’état précédent (mode pas à pas)
## Fabriqué avec
* [Qt](https://www.qt.io/) - Bibliothèque logicielle pour développer des interfaces graphiques
* [QtCreator](https://www.qt.io/product/development-tools) - IDE pour utiliser les bibliothèques spécifiques
## Contributing
Si vous souhaitez contribuer, lisez le fichier [CONTRIBUTING.md](https://example.org) pour savoir comment le faire.
## Versions
Listez les versions ici
_exemple :_
**Dernière version stable :** 5.0
**Dernière version :** 5.1
Liste des versions : [Cliquer pour afficher](https://github.com/your/project-name/tags)
_(pour le lien mettez simplement l'URL de votre projets suivi de ``/tags``)_
Version 1.1
## Auteurs
Listez le(s) auteur(s) du projet ici !
* **Jhon doe** _alias_ [@outout14](https://github.com/outout14)
Lisez la liste des [contributeurs](https://github.com/your/project/contributors) pour voir qui à aidé au projet !
* **Yann Boucher** _alias_ [@yboucher](https://gitlab.utc.fr/yboucher)
* **Arthur Detree** _alias_ [@detreear](https://gitlab.utc.fr/detreear)
* **Eugene Pin** _alias_ [@pineugen](https://gitlab.utc.fr/pineugen)
* **Anthony Noir** _alias_ [@noiranth](https://gitlab.utc.fr/noiranth)
* **Merwane Bouri** _alias_ [@bourimer](https://gitlab.utc.fr/bourimer)
_(pour le lien mettez simplement l'URL de votre projet suivi de ``/contirubors``)_
## License
Ce projet est sous licence ``exemple: WTFTPL`` - voir le fichier [LICENSE.md](LICENSE.md) pour plus d'informations
Ce projet est sous licence ``MIT License`` - voir le fichier [LICENSE.md](LICENSE.md) pour plus d'informations
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment