add readme.md

optim_to_opale/readme.md

+Optim to Opale (optim_to_opale)
+-------------------------------
+
+Last edit: December 17, 2015
+
+# Purpose
+
+`optim_to_opale` is an ANT script to convert a file from Optim format to Opale format.
+
+# Dependencies
+
+In order to work properly this script needs
+
+1. `optim_to_hdoc` (Optim to HDoc conversion)
+2. `hdoc_to_opale` (HDoc to Opale conversion)
+
+# Running the script
+
+1. Put the file you want to convert into the `input` directory
+2. Run the `run.sh`file on a Unix system (Linux, Mac OS, etc.) or the `run.bat`on Windows
+3. Your converted file is placed into the `output` directory (a log file is also placed into the `log`directory)
+4. Enjoy!
+
+# How is this script working
+
+1. The script first determines what OS you are using so it then can call the right scripts
+2. It cleans the `log`, `tmp`and `output`directories
+3. It copies the files that are inside the `input`directory to the `input` directory of `optim_to_hdoc`
+4. It calls `optim_to_hdoc`run script (`.bat` on windows, `.sh`on Unix)
+5. It copies the files that are inside the `output`directory of `optim_to_hdoc` to the `input` directory of `hdoc_to_opale`
+6. It calls `hdoc_to_opale`run script (`.bat` on windows, `.sh`on Unix)
+7. It copies the files that are inside the `output`directory of `hdoc_to_opale` to the `output` directory of `optim_to_opale`
+
+During all the process it also print both on screen and in the log file some basic information.