Commit 7b8fe03cb22daac5b1fad9485c961d5da0894c1d

Authored by Thorsieger
1 parent ef338579

update readMe

Showing 1 changed file with 19 additions and 19 deletions   Show diff stats
README.md
1 1 # Correcteur orthographique
2 2  
3   -> Réalisation d’un analyseur de fichier pour connaitre les mots faux.
4   -
5   -## Présentation rapide
6   -
7   -Ce programme permet de détecter dans un texte tous les mots mal orthographiés. Il accepte différents alphabets (latin, cyrillique, japonais ...). Il se base sur le dictionnaire que l'utilisateur donne et compte le nombre de mots non reconnu dans le fichier testé. Le programme n'est pas case sensitif mais gère les accents et caractères spéciaux.
  3 +> Réalisation d’un analyseur de fichier pour compter les mots non reconnu par rapport à un dictionnaire.
8 4  
9 5 ## Principe
10 6  
11   -Afin de minimiser l’espace mémoire nécessaire au stockage du dictionnaire tout en fournissant un temps de recherche bas, la structure de données que vous utiliserez sera un arbre préfixe (encore appelé trie). Il s’agit d’une structure arborescente pour laquelle des mots ayant des préfixes communs sont factorisés: chaque noeud de l’arbre est une lettre qui peut être terminale (i.e. dernière lettre d’un mot) ou pas.
  7 +Ce programme permet de détecter dans un texte tous les mots mal orthographiés. Il accepte différents alphabets (latin, cyrillique, japonais ...). Il se base sur le dictionnaire que l'utilisateur donne et compte le nombre de mots non reconnu dans le fichier testé. Le programme n'est pas sensible à la case mais gère les accents et caractères spéciaux.
12 8  
13   -Considérons les mots: were et will. L’arbre (ou [trie](https://en.wikipedia.org/wiki/Trie) ) correspondant est affiché ci-dessous à gauche. Si on ajoute les mots `we`, `wet` et `weave` l’arbre est affiché à droite; les noeuds colorés représentant des lettres terminales.
  9 +## Installation
14 10  
15   - ![](img/exemple_trie.png)
  11 +* Téléchargez tous les fichiers du projet
  12 +* Ouvrir un terminal à l'emplacement des fichiers
  13 +* Installer gcc (si nécessaire) ou modifiez le file makefile pour utiliser le compilateur de votre choix
  14 +* Tapez "make" dans le terminal (cela va créer l'exécutable "compteur_erreurs")
16 15  
17 16 ## Utilisation
18 17  
19   -Le travail que vous devez réaliser est le suivant:
  18 +* Lancer le programme ( ./compteur_erreurs)
20 19  
21   -- Définir et implémenter une structure de données permettant de stocker et de manipuler un dictionnaire sous forme d’arbre préfixe / trie.
22   -- Charger un dictionnaire à partir d’un fichier texte de données. Ce fichier texte pouvant être un texte court, un roman ou une liste de mots. Par exemple le fichier `/etc/dictionaries-common/words` est un dictionnaire de langue anglaise.
23   -- Analyser l’orthographe d’une phrase ou d’un texte en indiquant les nombres de mots qui ne sont pas reconnus par le dictionnaire.
  20 +* Donnez le nom du dictionnaire/texte que vous souhaiez utiliser (le nom ne doit pas contenir d'espaces):
  21 + * Soit en donnant le chemin complet du fichier : (/home/usr/chemin/fichier/dico.txt)
  22 + * Soit en placant le dictionnaire à l'emplacement de l'exécutable et en entrant simplement son nom
  23 + * Soit en utilisant les 3 dictionnaires disponibles (words/american-english ou words/french ou words/brithish-english)
24 24  
25   -Vous accorderez un soin particulier à l’ergonomie de votre programme (choix du dictionnaire, choix du texte à analyser).
  25 +* Vous pouvez ensuite modifier les caractères de séparation d'un texte (points, virgules, etc. ) en appuyant sur [Y] ou conserver la liste déja disponible.
26 26  
27   -## Installation
  27 +* Il vous faut maintenant donner le nom du fichier à corriger. (soit chemin absolu, soit fichier placé dans le répertoir de l'exécutable). Ici encore le nom du fichier ne doit pas contenir d'espaces.
  28 +
  29 +* Le programme vous indique le nombre de mots non reconnu.
  30 +
  31 +* Vous pouvez maintenant soit quitter le programme soit relancer une analyse d'un autre fichier.
28 32  
29   -Pour le dimanche 5 mai 23:59 (CEST) vous devrez remettre à votre tuteur un accès à votre dépôt GIT qui contiendra:
30   -- un rapport de moins de 10 pages au format PDF contenant l’analyse de votre projet (structures de données, structuration de votre programme), les explications concernant les algorithmes principaux, le respect du cahier des charges et/ou les limitations de votre programme.
31   -- le code source de votre projet ainsi que le Makefile permettant de le compiler automatiquement.
32   -- un fichier README qui contiendra une description rapide de votre programme ainsi qu’un mode d’emploi.
33   -- des fichiers de tests éventuels
  33 +*Pour changer de dictionnaire il vous faudra relancer le programme.*
34 34 \ No newline at end of file
... ...