Skip to content
Snippets Groups Projects
Commit 76904c48 authored by erwan's avatar erwan
Browse files

Enhance doc

parent 62f272f0
No related branches found
No related tags found
No related merge requests found
- [Dot files](#orgcb004aa)
- [Algorithms](#org725c8e5)
- [Simulation](#org58ece13)
- [Installation (not yet working)](#org917b30f)
- [Dot files](#orga1a97e0)
- [Algorithms](#orgf52cd3e)
- [Simulation](#orgbe2dc00)
- [Installation (not yet working)](#orgdeec637)
Basically, one needs to provide
......@@ -9,7 +9,7 @@ Basically, one needs to provide
2. the algorithms mentionned in the dot file
<a id="orgcb004aa"></a>
<a id="orga1a97e0"></a>
# Dot files
......@@ -33,7 +33,7 @@ graph ring {
```
<a id="org725c8e5"></a>
<a id="orgf52cd3e"></a>
# Algorithms
......@@ -49,7 +49,7 @@ More precisely, each algorithm should provide 3 functions that must be registred
- `reg_enable`
- `reg_step`
which profiles is defined in <../lib/algo/algo.mli>
which profiles is defined in [algo.mli](https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa/blob/master/lib/algo/algo.mli)
Algorithms must then be compiled with `ocamlopt -shared` to produce the cmxs files mentionned in the dot file algo fields.
......@@ -60,7 +60,7 @@ ocamlopt -shared -I +sasa some_algo.ml -o some_algo.cmxs
Some examples can be found in the <./test/> directory.
<a id="org58ece13"></a>
<a id="orgbe2dc00"></a>
# Simulation
......@@ -70,7 +70,7 @@ sasa --help
```
<a id="org917b30f"></a>
<a id="orgdeec637"></a>
# Installation (not yet working)
......
......@@ -39,7 +39,7 @@ registred using the string used in dot file algo fields with:
- =reg_enable=
- =reg_step=
which profiles is defined in [[file:../lib/algo/algo.mli]]
which profiles is defined in [[https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa/blob/master/lib/algo/algo.mli][algo.mli]]
Algorithms must then be compiled with =ocamlopt -shared= to produce
the cmxs files mentionned in the dot file algo fields.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment