Commit 05e933c6 authored by Ivan D'halluin's avatar Ivan D'halluin

rewrite readme to have the correct structure

parent dd0ea0ae
Usage
-----
Optim to Hdoc
=============
Put `.scar` files in the input folder, run `run.bat` or `run.sh` and get results in output folder (one folder and a .hdoc per .scar).
Licence
-------
License GPL3.0
http://www.gnu.org/licenses/gpl-3.0.txt
Todo list
---------
- tests more files
- clean output of optim source files
- resolve bugs
- test the entier process from optim to opale
- the level of unit of content for the Opal conversion if basically set to sections witch doesn't contains any section but some could need it to be set to another level. Create a selection of this level could be a next step for this project.
Credits
-------
Bugs
----
Ivan D'halluin, Sylvain Lagache, Frédéric Le Feurmou.
User documentation
------------------
Use the project as describe in the root README. You can convert multiple files by putting all `.scar` in the input folder.
Known bugs
----------
- references of sections or fragments inside a paragraphe
- can create divs with only h6
Transformation
--------------
Todo
----
- tests more files
- clean output of optim source files
- resolve bugs
- the level of unit of content for the Opal conversion if basically set to sections witch doesn't contains any section but some could need it to be set to another level. Create a selection of this level could be a next step for this project.
Technicals notes
----------------
| Optim start tag (or structures) | HDOC end tag | Note |
|---------------------------------|-------------------------------------|---------------------------------------------|
......@@ -79,4 +95,5 @@ Transformation
| tree | <div><h6/><p/></div> | The structure of trees cannot be converted |
| | | and the result is a list a blocks |
|---------------------------------|-------------------------------------|---------------------------------------------|
| title | <h6> | |
\ No newline at end of file
| title | <h6> | |
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