Blame view

README.md 2.94 KB
edcda23e   ccalleri   Update Readme : E...
1
  # Projet Programmation Avancée : Correcteur Orthographique 
d4da0378   jdequidt   Initial commit
2
  
edcda23e   ccalleri   Update Readme : E...
3
4
  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. 
  Auteurs : Sébastien Dardenne et Corto Callerisa
d4da0378   jdequidt   Initial commit
5
  
faeaeb2e   ccalleri   Update Readme fro...
6
  ![](https://github.com/Tywacol/EPFL_imhof/blob/master/examples_files/interlaken/interlakenhighHD300.png?raw=true)
d4da0378   jdequidt   Initial commit
7
  
edcda23e   ccalleri   Update Readme : E...
8
  ## Principe
d4da0378   jdequidt   Initial commit
9
  
edcda23e   ccalleri   Update Readme : E...
10
  Le programme importe un dictionnaire depuis un fichier texte passé en paramètre et s'en sert pour détecter les mots mal orthographié d'un texte donné.
d4da0378   jdequidt   Initial commit
11
  
edcda23e   ccalleri   Update Readme : E...
12
  ## Prérequis
d4da0378   jdequidt   Initial commit
13
  
edcda23e   ccalleri   Update Readme : E...
14
  Un ordinateur permettant de compiler en programme C ainsi qu'environ 10mo d'espace libre. La majorité de la mémoire étant occupé par les fichiers de tests, l'éxecutable faisant environ 23Ko.
d4da0378   jdequidt   Initial commit
15
  
faeaeb2e   ccalleri   Update Readme fro...
16
  ## Installation
d4da0378   jdequidt   Initial commit
17
  
faeaeb2e   ccalleri   Update Readme fro...
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
  You can clone the project with
  ```bash
  git clone git@github.com:Tywacol/EPFL_imhof.git
  ```
  and compile it with
  
  ```bash
  cd EPFL_imhof
  javac ch/epfl/imhof/Main.java
  ```
  
  ## Usage
  Arguments
  ```bash
  java Main osmFile.osm.gz, hgtFile.hgt, botLeftLon, botLeftLat, topRightLong, topRightLat, rDpi, output_name
  ```
  *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.
  
  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 
  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. 
  
  To compress the file on linux, run :
  
  ```bash
  gzip map.osm 
  ```
  *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.
  
  *botLeftLon, botLeftLat, topRightLong, topRightLat* : Coordinates of the bottom-left and top-right corner of the area inside of OSM file.
  
  *rDpi* : it's the dpi of the final map. More means better details but increasing file size and runtime. 100 produces mostly balanced results.
  
  *output_name* : the name of the file generated.
  
  As an example the command to generate the map of interlaken in examples_files/interlaken/command.txt is :
  ```bash
  java -cp . ch.epfl.imhof.Main interlaken_high.osm.gz N46E007.hgt 7.7248 46.6348 7.9943 46.7377 300 interlakenhighHD300.png
  ```
  
  ## Contributing
  Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
  
  Please make sure to update tests as appropriate.
  
  ## License
edcda23e   ccalleri   Update Readme : E...
63
  [MIT](https://choosealicense.com/licenses/mit/)