Commit 3454da113c6f8ad864321912ab545d555d579381
1 parent
b2135db0
Readme ajout des differentes parties
Showing
1 changed file
with
18 additions
and
31 deletions
Show diff stats
README.md
| @@ -3,7 +3,7 @@ | @@ -3,7 +3,7 @@ | ||
| 3 | Ce programme implémente un correcteur orthographique minimaliste écrit en C dans le cadre du cours de Programmation Avancée de Mr. [Rudametkin](https://rudametw.github.io/) d'IMA3 à Polytech'Lille. | 3 | Ce programme implémente un correcteur orthographique minimaliste écrit en C dans le cadre du cours de Programmation Avancée de Mr. [Rudametkin](https://rudametw.github.io/) d'IMA3 à Polytech'Lille. |
| 4 | Auteurs : Sébastien Dardenne et Corto Callerisa | 4 | Auteurs : Sébastien Dardenne et Corto Callerisa |
| 5 | 5 | ||
| 6 | - | 6 | + |
| 7 | 7 | ||
| 8 | ## Principe | 8 | ## Principe |
| 9 | 9 | ||
| @@ -15,49 +15,36 @@ Un ordinateur permettant de compiler en programme C ainsi qu'environ 10mo d'espa | @@ -15,49 +15,36 @@ Un ordinateur permettant de compiler en programme C ainsi qu'environ 10mo d'espa | ||
| 15 | 15 | ||
| 16 | ## Installation | 16 | ## Installation |
| 17 | 17 | ||
| 18 | -You can clone the project with | 18 | +Le projet peut être cloner par la commande |
| 19 | ```bash | 19 | ```bash |
| 20 | -git clone git@github.com:Tywacol/EPFL_imhof.git | 20 | +git clone git@archives.plil.fr:ccalleri/ima3_projet_pa_2019.git |
| 21 | ``` | 21 | ``` |
| 22 | -and compile it with | 22 | +et compilé avec |
| 23 | 23 | ||
| 24 | ```bash | 24 | ```bash |
| 25 | -cd EPFL_imhof | ||
| 26 | -javac ch/epfl/imhof/Main.java | 25 | +cd ima3_projet_pa_2019 |
| 26 | +make | ||
| 27 | ``` | 27 | ``` |
| 28 | 28 | ||
| 29 | -## Usage | 29 | +## Utilisation |
| 30 | Arguments | 30 | Arguments |
| 31 | ```bash | 31 | ```bash |
| 32 | -java Main osmFile.osm.gz, hgtFile.hgt, botLeftLon, botLeftLat, topRightLong, topRightLat, rDpi, output_name | 32 | +./correcteur [fichier_dictionnaire] texte |
| 33 | ``` | 33 | ``` |
| 34 | -*osmFile.osm.gz* : the compressed data corresponding to the desired area. To create one go to <www.openstreetmap.org>, chose the location and the dimensions than click the export button. | 34 | +fichier_dictionnaire : le fichier texte contenant l'ensembles des mots du dictionnaire. S'il n'est pas spécifié le dictionnaire par défaut est utilisé. |
| 35 | 35 | ||
| 36 | -Note : since a single .hgt file can contains data for a square of 1 of longitude and 1 of lattitude, the latittude and longitude of the area you chosen must be contained within 1 of each other. Example: the coordinate for interlaken are | ||
| 37 | -7.7248 -> 7.994 in longitude and 46.6348 -> 46.7377 in latitude, it's in N46E007.hgt. Here 6.9999 -> 7.994 wouldn't work. | 36 | +texte : texte à vérifier. |
| 38 | 37 | ||
| 39 | -To compress the file on linux, run : | 38 | +Le programme renvoie l'ensemble des mots malorthographiés sur le terminal. |
| 39 | +## Extras : Benchmark, warnings et gestion mémoire. | ||
| 40 | 40 | ||
| 41 | -```bash | ||
| 42 | -gzip map.osm | ||
| 43 | -``` | ||
| 44 | -*hgtFile.hgt* : The hgt file can be downloaded from <http://viewfinderpanoramas.org/dem3.html>. Choose your regions than click on the interactive map to download the file. You may need to extract it. Note that there is 3 resolutions available : 1" 3" and 15" (arc second). the smaller, the better the details of the digital elevation model. 1" is not available everywhere but 3", however the use of 15" is discouraged due to the lack of precision. | ||
| 45 | - | ||
| 46 | -*botLeftLon, botLeftLat, topRightLong, topRightLat* : Coordinates of the bottom-left and top-right corner of the area inside of OSM file. | ||
| 47 | - | ||
| 48 | -*rDpi* : it's the dpi of the final map. More means better details but increasing file size and runtime. 100 produces mostly balanced results. | 41 | +### Benchmark |
| 49 | 42 | ||
| 50 | -*output_name* : the name of the file generated. | ||
| 51 | - | ||
| 52 | -As an example the command to generate the map of interlaken in examples_files/interlaken/command.txt is : | ||
| 53 | -```bash | ||
| 54 | -java -cp . ch.epfl.imhof.Main interlaken_high.osm.gz N46E007.hgt 7.7248 46.6348 7.9943 46.7377 300 interlakenhighHD300.png | ||
| 55 | -``` | 43 | +### Warnings |
| 56 | 44 | ||
| 57 | -## Contributing | ||
| 58 | -Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. | 45 | +### Gestion mémoire |
| 59 | 46 | ||
| 60 | -Please make sure to update tests as appropriate. | 47 | +## Auteurs |
| 61 | 48 | ||
| 62 | -## License | ||
| 63 | -[MIT](https://choosealicense.com/licenses/mit/) | ||
| 64 | \ No newline at end of file | 49 | \ No newline at end of file |
| 50 | +Sébastien Dardenne | ||
| 51 | +Corto Callerisa | ||
| 65 | \ No newline at end of file | 52 | \ No newline at end of file |