diff --git a/README.md b/README.md index 3122d9a..d358b84 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,43 @@ # NumericWordsConverter -NumericWordsConverter est un script Python simple mais puissant qui convertit des nombres écrits en chiffres en leur équivalent en lettres. Que vous ayez besoin de générer des montants en toutes lettres pour des chèques, des factures ou simplement par curiosité, ce script vous facilitera la tâche. + +NumericWordsConverter est un script Python qui permet de convertir des nombres écrits en chiffres en leur équivalent en lettres. Ce script est utile pour générer des montants en toutes lettres, que ce soit pour des chèques, des factures ou tout autre besoin nécessitant une représentation textuelle d'un nombre. + +## Utilisation + +1. **Clonez le dépôt vers votre machine locale :** + + ```bash + git clone https://github.com/votre-utilisateur/NumericWordsConverter.git + ``` + +2. **Naviguez vers le répertoire du script :** + + ```bash + cd NumericWordsConverter + ``` +3. **Exécutez le script en spécifiant le nombre à convertir :** + + ```bash + python numeric_words_converter.py + ``` + +4. **Obtenez le résultat en toutes lettres !** + +## Exemple + +Supposons que vous souhaitez convertir le nombre 123456789 en lettres. Après avoir exécuté le script et saisi le nombre, vous obtiendrez : + + ```yaml + Entrez un nombre : 1234567890 + un milliard deux cent trente quatre million cinq cent soixante sept mille huit cent quatre-vingt-dix + ``` + +## Contributions + +Les contributions sont les bienvenues ! Si vous avez des idées d'amélioration, des corrections de bugs, ou toute autre suggestion, n'hésitez pas à créer une issue ou à soumettre une pull request. + +**Merci de contribuer à NumericWordsConverter !** + +## Licence + +Ce projet est sous licence [Apache 2.0](LICENSE).