Skip to content

Commit

Permalink
Completion du magnifique README :)
Browse files Browse the repository at this point in the history
  • Loading branch information
Emprario committed Dec 18, 2023
1 parent b9b48cf commit c048d39
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,14 @@

## Dependencies

Juste python 3, et
* `os` module
* `math` module
* aucun modules du PyPI requis :)
Ce programme utilise uniquement python 3
Ce programme est indépendant de l'OS (windows, mac, linux)
Modules natifs utilisés:
* `math` pour le calcul du logarithme décimal
* `os` pour lister les fichiers et effacer la console

Ce programme fourni un corpus de document dans `/speeches`. On peut les remplacer ou en ajouter d'autres, ils doivents juste avoir la syntaxe suivante : `/speeches/Nomination_*.txt` avec la partie à compléter un nom de président que l'on peut retrouver dans les cleés du dictionnaire `NOM_PRENOM` dans le module `/consts.py`.


> [!WARNING]
> La version de Python doit être au-dessus ou égale 3.11.0
Expand All @@ -19,12 +23,15 @@ Juste python 3, et
* Cloner le repo via `git clone https://github.com/Emprario/pychatbot-cameleri-guignolle-a`
* Se déplacer dans le **dossier courant du projet** `cd pychatbot-cameleri-guignolle-a`
* Executer avec python `py main.py`
* Après affichage du prompt, entrer le numéro du programme souhaité !

Le programme se décompose en deux parties : Chatbot et menu rapide, pour répondre aux menus, vous devez entrer le numéro du choix sélectionné.

> [!TIP]
> Vous pouvez executer plusieurs fois le programme après appuye de `Entrée` pour effacer la console
> Vous pouvez également retourner au menu principal en utilisant le choix 0 dans le sous menu des accès rapides
## Known bugs

Il n'y a pas de bug connus dans le projet.
Si vous en trouvez, n'hésitez pas à les reporter via [issues](https://github.com/Emprario/pychatbot-cameleri-guignolle-a/issues)
Il n'existe pas de bug majeur connu.
Toutes les saisies sont sécurisées sauf celui de la saisie du nombre à virgule flotante dans le choix du seuil pour le score TF-IDF.
Si vous en trouvez, n'hésitez pas à les reporter via [issues](https://github.com/Emprario/pychatbot-cameleri-guignolle-a/issues)

0 comments on commit c048d39

Please sign in to comment.