Amélioration de la mise en page avec Markdown du fichier README.md

LICENCE.md

@@ -0,0 +1,7 @@
+Copyright 2026 AntoineVe & Brunus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,42 +1,107 @@
 # wgamesolv
 
-WARNING : le dictionnaire fr_FR.json n'est plus à jour. Il doit soit être mis à jour soit remplacé par des dictionnaires de mots en x lettres, comme le nouveau fr_A_10letters.json (mots de 10 lettres commençants par la letre A) qui lui est à jour (le 26 fév. 2026).
+> **Words Games Solver** — Script d'aide à la résolution des jeux de mots style Wordle, SUTOM, mots-croisés, Scrabble...
+> On a fait ça pour s'amuser, pas spécialement pour tricher aux jeux de mots.
 
-Words Games Solver.    
+ - **Auteurs :** AntoineVe, Brunus
-Script d'aide à la résolution des jeux de mots style Wordle, SUTOM, mots-croisés, Scrabble...     
+ - **Courageux testeur des 1ères versions et précieux apporteur d'idées :** DarKou
-On a fait ça pour s'amuser, pas spécialement pour tricher aux jeux de mots.  
+ - **Licence :** MIT
-Auteurs : AntoineVe, Brunus.  
-Courageux testeur des 1ères versions et précieux apporteur d'idées: DarKou.  
-Licence : MIT  
 
-Utilisation : wgamesolv.py -d dictionnaire.json -nb 7 (autres options)
+---
 
--d, --dictionary : dictionnaire à utiliser  
+> [!WARNING]
-ex : -d fr_Fc.json  
+> Le dictionnaire `fr_FR.json` n'est plus à jour. Il doit soit être mis à jour soit remplacé par des dictionnaires de mots en x lettres, comme le nouveau `fr_A_10letters.json` (mots de 10 lettres commençant par la lettre A) qui lui est à jour (le 26 fév. 2026).
-Trois dictionnaires ont été fusionnés pour n'en faire qu'un : Wordle, SUTOM et l'officiel du Scrabble  
 
--fl, --firstLetter : première lettre du mot  
+---
-ex : -fl C  
-Cette option est intéressante que l'on connaisse ou non la première lettre, il faut en choisir une pour limiter la liste de mots possibles.  
 
--nb, --nbLetters : nombre de lettres qui composent le mot  
+## Utilisation
-ex : -nb 7  
 
--ft, --firstTry : optimise le premier essai en sortant les mots de -nb lettres, commençant par -fl lettre, ne contenant aucune lettre en plusieurs occurence et contenant -ft voyelles.  
+```
-ex : -ft 4  
+wgamesolv.py -d dictionnaire.json -nb 7 [autres options]
-Cette option peut être utilisée pour le tout premier essai, pour optimiser les chances d'avoir des lettres validées.  
+```
-Cette option est ensuite inutile ou contre-productive pour les essais suivants et ne peut pas être utilisée avec la pattern.  
 
--nd, --noDoubleLetters : filtre les mots composé d'une seule occurence de chaque lettre.
+## Options
 
--kl, --knownLetters : lettres déjà validées  
+### `-d`, `--dictionary` — dictionnaire à utiliser
-ex : -kl AEP
 
--bl, --badLetters : lettres déjà invalidées  
+```
-ex : -bl ZTOR
+-d fr_FR.json
+```
 
--p, --pattern : lettres validées et bien placées, lettres connues et mal placées, séparée par des '.' pour les lettres non validées  
+Trois dictionnaires ont été fusionnés pour n'en faire qu'un : Wordle, SUTOM et l'officiel du Scrabble.
-Les lettres en caps sont les lettres connues et bien placées, les lettres en minuscules sont les lettres connues mais mal placées    
-ex : -p L.uI... (le mots était LUCIOLE)
 
-Exemple complet : wgamesolv.py -d fr_FR.json -nb 7 -fl L -p L.uI... -kl U -bl AMNR
+---
+
+### `-nb`, `--nbLetters` — nombre de lettres du mot
+
+```
+-nb 7
+```
+
+---
+
+### `-fl`, `--firstLetter` — première lettre du mot
+
+```
+-fl C
+```
+
+Cette option est intéressante que l'on connaisse ou non la première lettre : il faut en choisir une pour limiter la liste de mots possibles.
+
+---
+
+### `-ft`, `--firstTry` — optimisation du premier essai
+
+```
+-ft 4
+```
+
+Optimise le premier essai en sortant les mots de `-nb` lettres, commençant par `-fl`, ne contenant aucune lettre en plusieurs occurrences et contenant `-ft` voyelles.
+
+> Cette option peut être utilisée pour le tout premier essai, pour optimiser les chances d'avoir des lettres validées. Elle est ensuite inutile ou contre-productive pour les essais suivants et **ne peut pas être utilisée avec la pattern**.
+
+---
+
+### `-nd`, `--noDoubleLetters` — sans lettres doublées
+
+Filtre les mots composés d'une seule occurrence de chaque lettre.
+
+---
+
+### `-kl`, `--knownLetters` — lettres déjà validées
+
+```
+-kl AEP
+```
+
+---
+
+### `-bl`, `--badLetters` — lettres déjà invalidées
+
+```
+-bl ZTOR
+```
+
+---
+
+### `-p`, `--pattern` — lettres placées et mal placées
+
+```
+-p L.uI...
+```
+
+| Casse | Signification |
+|-------|---------------|
+| Majuscule | Lettre connue et **bien placée** |
+| minuscule | Lettre connue mais **mal placée** |
+| `.` | Position non validée |
+
+*Exemple : `-p L.uI...` pour le mot LUCIOLE*
+
+---
+
+## Exemple complet
+
+```
+wgamesolv.py -d fr_FR.json -nb 7 -fl L -p L.uI... -kl U -bl AMNR
+```