From 76904c488eedd40e1da2c05bbf7175843d7b6861 Mon Sep 17 00:00:00 2001
From: Erwan Jahier <erwan.jahier@univ-grenoble-alpes.fr>
Date: Thu, 7 Mar 2019 15:33:07 +0100
Subject: [PATCH] Enhance doc
---
doc/README.md | 18 +++++++++---------
doc/README.org | 2 +-
2 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/doc/README.md b/doc/README.md
index 81330f7f..9ba3e185 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -1,7 +1,7 @@
-- [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)
diff --git a/doc/README.org b/doc/README.org
index 0a136c96..edda1b73 100644
--- a/doc/README.org
+++ b/doc/README.org
@@ -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.
--
GitLab