This project is under [GPL 3.0 licence](http://www.gnu.org/licenses/gpl-3.0.txt).
# Purpose
Credits
-------
### Autumn 2015
`optim_to_opale` is an ANT script to convert a file from Optim format to Opale format.
* Ivan D'HALLUIN
* JEFFREY DECORDE
* Jean-Baptiste MARTIN
# Dependencies
Presentation
------------
`optim_to_opale` is an ANT script that converts a file from Optim format to Opale format. It simply calls `optim_to_hdoc`and `hdoc_to_opale`scripts.
Dependencies
------------
In order to work properly this script needs
In order to work properly this script needs
1.`optim_to_hdoc` (Optim to HDoc conversion)
1.[`optim_to_hdoc`](https://gitlab.utc.fr/crozatst/hdoc/tree/master/optim_to_hdoc)(Optim to HDoc conversion)
2.`hdoc_to_opale` (HDoc to Opale conversion)
2.[`hdoc_to_opale`](https://gitlab.utc.fr/crozatst/hdoc/tree/master/hdoc_to_opale)(HDoc to Opale conversion)
# Running the script
User Documentation
------------------
### Running the script
1. Put the file you want to convert into the `input` directory
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
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)
3. Your converted file is placed into the `output` directory (a log file is also placed into the `log`directory)
4. Enjoy!
4. Enjoy!
# How is this script working
### How is this script working
1. The script first determines what OS you are using so it then can call the right scripts
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
2. It cleans the `log`, `tmp`and `output`directories
...
@@ -32,3 +45,21 @@ In order to work properly this script needs
...
@@ -32,3 +45,21 @@ In order to work properly this script needs
7. It copies the files that are inside the `output`directory of `hdoc_to_opale` to the `output` directory of `optim_to_opale`
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 prints some basic information both on screen and in the log file.
During all the process it also prints some basic information both on screen and in the log file.
Unsupported
-----------
* The script currently doesn't support any paramater to specify the file to convert. If multiple files are in the `input`directory, the script will convert all these files.
