Commit af18451d authored by Jean-Baptiste Martin's avatar Jean-Baptiste Martin

updated readme file

parent e723778a
Optim to Opale (`optim_to_opale`)
===============================
Last edit: January 4, 2016
=================================
Last edit: January 6, 2016
License
-------
......@@ -16,7 +16,7 @@ Credits
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.
`optim_to_opale` is an ANT script that converts files from Optim format to Opale format. It simply calls `optim_to_hdoc` and `hdoc_to_opale` scripts.
Dependencies
------------
......@@ -34,18 +34,6 @@ User Documentation
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 prints some basic information both on screen and in the log file.
Unsupported
-----------
......@@ -71,8 +59,18 @@ This feature requires that the same feature has been implementing in `optim_to_h
Technical notes
---------------
### 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 prints some basic information both on screen and in the log file.
Capitalization
--------------
While working on this project, we have learned more about ANT scripting (more specifically bulding an multi-os script and running scripts by detecting the OS) and about problem solving in general (how to go from one specific need to a result).
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment