Docs: use guides/users/README.html as the project main page

.gitlab-ci.yml

@@ -28,3 +28,12 @@ release:
   script:
     - $(yarn bin)/semantic-release-gitlab  --preset eslint
   stage: release
+
+pages:
+  stage: deploy
+  script:
+    - cp guides/users/README.html public/index.html
+    - cp -rf guides/users/styles  public/
+  artifacts:
+    paths:
+      - public

guides/users/README.org

@@ -14,20 +14,24 @@
 
 
 * TL;DR 
+
+SASA is a *Self-stabilizing Algorithms SimulAtor*, based on the
+so-called *state model* introduced by _Dijkstra_ in its seminal article
+on [[http://www.cs.utexas.edu/~EWD/ewd04xx/EWD426.PDF][Self-stabilizing distributed algorithms]]
+
 Basically, one needs to provide:
 1. a topology, made of nodes and channels (via a dot file)
 2. the algorithms attached to nodes (via =ocaml= programs)
 
-Now, suppose you have a topology defined in =g.dot=, that refers to an
-algorithm defined in the ocaml program =p.ml=, you can simulate it as
-follows:
+Now, suppose you have a topology defined in =ring.dot=, that refers to
+an algorithm defined in the ocaml program =p.ml= (cf =test/skeleton/=
+directory), you can simulate it as follows:
 
 #+BEGIN_SRC sh
 ocamlfind ocamlopt -shared -package sasacore p.ml -o p.cmxs
 sasa g.dot
 #+END_SRC
 
-
 * Topology
 
 The topology is given via =.dot= files, that  should 
@@ -117,7 +121,6 @@ Some examples can be found in the [[https://gricad-gitlab.univ-grenoble-alpes.fr
  
 * Batch Simulations
 
-XXX renommer skeleton en tuto, et y faire reference ici 
 
 ** Running batch simulations with Built-in demons
 
@@ -408,7 +411,6 @@ opam update
 opam upgrade
 #+END_SRC
 
-
 * More 
 
 - Releases Notes: https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa/releases

guides/users/emacs-org.el

+
+
+(setq load-path (cons (expand-file-name "./el/") load-path))
+
+
+(setq auto-mode-alist (cons '("\\.lut$" . lutin-mode) auto-mode-alist))
+(setq auto-mode-alist (cons '("\\.lus$" . lustre-mode) auto-mode-alist))
+(setq auto-mode-alist (cons '("\\.rif$" . rif-mode) auto-mode-alist))
+
+
+(autoload 'rif-mode "rif" "" t)
+(autoload 'lutin-mode "lutin" "Edition de code lutin" t)
+(autoload 'lustre-mode "lustre" "Edition de code lustre" t)
+
+
+(require 'org)
+
+(require 'htmlize)
+(require 'ob)
+(require 'ob-dot)
+(require 'ob-ocaml)
+(require 'zenburn)
+
+
+;; make sure that when we export in HTML, that we don't export with inline css.
+;; that way the CSS of the HTML theme will be used instead which is better
+(setq org-html-htmlize-output-type 'css)
+
+(setq org-src-fontify-natively t)
+(setq org-src-preserve-indentation t)
+
+;(setq  org-confirm-babel-evaluate t)
+
+(defun my-org-confirm-babel-evaluate (lang body)
+  (and (not (string= lang "dot")) (not (string= lang "sh"))))
+(setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
+
+
+(org-babel-do-load-languages
+ 'org-babel-load-languages
+ '((emacs-lisp . t)
+   (ocaml . t)
+   (dot . t)
+   (lustre . t)
+   (rif . t)
+   (sh . t)
+   )
+ )
+
+;;; pour faire comme suggeré ici
+;;; https://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg00857.html
+;;; mais ca ne fonctionne pas (avec cette vrsion de org-mode)
+;; (add-hook 'org-babel-tangle-body-hook
+;;             (lambda () (org-export-preprocess-apply-macros)))