diff --git a/README.md b/README.md index adb3881..f4cc83a 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,10 @@ # UniSquat -Application pour trouver rapidement les salles disponibles dans l'Université de Strasbourg (version Python). +Application pour trouver rapidement les salles disponibles dans l'Université de Strasbourg. -Cette application dispose d'une interface Web fonctionnant avec Flask (voir [https://unisquat.alwaysdata.net](https://unisquat.alwaysdata.net)). +Cette application dispose d'une interface Web fonctionnant avec Flask ( [voir la demo](homepage) ). -UniSquat est disponible en C++ ici : [https://forge.chapril.org/Wantoo/UniSquat](https://forge.chapril.org/Wantoo/UniSquat) - -# Dependances +## Dépendances Pour l'instant, ce programme utilise les modules suivants : - datetime @@ -14,4 +12,52 @@ Pour l'instant, ce programme utilise les modules suivants : - requests Pour la version Web (avec Flask) : -- flask \ No newline at end of file +- flask + +## Comment lancer la version web/Flask + +C'est la version la plus aboutie. + +Dans la racine du dossier : + +```python +flask run +``` + +C'est la version la plus utilisable, n'hésitez pas à héberger votre propre version. + +## Version antérieures + +Ces versions sont plus anciennes, rudimentaires, et ne sont pas prévues pour être utilisables. + +### Interface en ligne de commande + +Un interface en ligne de commande est disponible. Elle ne nécessite pas de dépendances supplémentaires. + +Pour le lancer : + +```python +python main_cli.py +``` + +### Interface Qt5 + +Interface graphique utilisant la bibliothèque Qt. Elle nécessite le module `PyQt5`. + +Pour le lancer : + +```python +python main_gui.py +``` + +## Crédits + +Le code est sous licence [GPLv3](https://choosealicense.com/licenses/gpl-3.0/). + +UniSquat est créé par deux étudiants de l'université, plus d'information sur [notre site](homepage). + +Notre travail est fait bénévolement, mais si vous voulez nous soutenir, passez au campus d'esplanade nous offrir un chocolat chaud ❤ + +Vous pouvez nous contacter sur nos comptes gitea respectifs, ou vous pouvez aller voir sur le [blog de @ayte](https://webair.xyz/fr/contact) pour plus d'options. + +[homepage]: https://unisquat.alwaysdata.net