diff --git a/AUTHORS.txt b/AUTHORS.txt deleted file mode 100644 index c9f93bcc312aab4b3699157c1e8cd4a94884b0b3..0000000000000000000000000000000000000000 --- a/AUTHORS.txt +++ /dev/null @@ -1,12 +0,0 @@ -(* OASIS_START *) -(* DO NOT EDIT (digest: e0c07255abb5e78e10ac950c68a2b7d7) *) - -Authors of lustre-v6: - -* Erwan Jahier and Pascal Raymond - -Current maintainers of lustre-v6: - -* erwan.jahier@univ-grenoble-alpes.fr - -(* OASIS_STOP *) diff --git a/INSTALL.txt b/INSTALL.txt deleted file mode 100644 index b5ca2731989912c3d75dc44b4a738123c032004c..0000000000000000000000000000000000000000 --- a/INSTALL.txt +++ /dev/null @@ -1,49 +0,0 @@ -(* OASIS_START *) -(* DO NOT EDIT (digest: 512dbf0dbc8375e376976d422e55665d) *) - -This is the INSTALL file for the lustre-v6 distribution. - -This package uses OASIS to generate its build system. See section OASIS for -full information. - -Dependencies -============ - -In order to compile this package, you will need: - -* ocaml (>= 4.02) -* findlib -* lutils for executable lv6, executable lv6.dbg -* extlib for executable lv6, executable lv6.dbg -* rdbg for library lustre-v6 - -Installing -========== - -1. Uncompress the source archive and go to the root of the package -2. Run 'ocaml setup.ml -configure' -3. Run 'ocaml setup.ml -build' -4. Run 'ocaml setup.ml -install' - -Uninstalling -============ - -1. Go to the root of the package -2. Run 'ocaml setup.ml -uninstall' - -OASIS -===== - -OASIS is a program that generates a setup.ml file using a simple '_oasis' -configuration file. The generated setup only depends on the standard OCaml -installation: no additional library is required. - -(* OASIS_STOP *) - -Installing alt -============== - -As a shortcut for installing command above, one can also use good old: -make configure -make -make install diff --git a/README.org b/README.org new file mode 100644 index 0000000000000000000000000000000000000000..0f6bb23132825917389203238da6ae30934e93b3 --- /dev/null +++ b/README.org @@ -0,0 +1,56 @@ + +lustre-v6 - The Lustre V6 Verimag compiler + + +This package contains: + - lv6: the (current) name of the compiler (and interpreter via -exec) + - the lustre-v6 ocaml lib: to call the Lustre v6 interpreter from ocaml + - the lustre-v6 rdbg plugin: to debug Lustre v6 program with rdbg + +* Installing =lustre-v6= via opam + +End users ougth to install =lustre-v6= via opam. + +#+BEGIN_SRC sh +$ opam repo add verimag-sync-repo "http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/opam-repository" +$ opam update +$ opam install lustre-v6 +#+END_SRC + +* Installing =lustre-v6= via pre-compiled binaries + +cf the Install section of http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/lustre-v6/ + +* Installing the (git controlled) source + +You first need to install dune and gnu-make. To have all the necessary +dependencies, it migth help to use opam + +#+BEGIN_SRC sh +opam install lutils lustre-v6 +opam remove lutils lustre-v6 +#+END_SRC + + +Then you should install lutils (either via opam or via the git repo) +https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/lutils + +Then 'make' should build all the executables, 'make install' should +install everything, and 'make test' ougth to exit with a 0 return +code. + +#+BEGIN_SRC sh +opam install lutils extlib +git clone https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/lustre-v6/lustre-v6.git +cd lustre-v6 +make +make install +make test +#+END_SRC + + +* Contribute + +To contribute, you need to create an account on https://gricad-gitlab.univ-grenoble-alpes.fr + +----- diff --git a/README.txt b/README.txt deleted file mode 100644 index 5d286b79851a26d88f74bb4d2e3f8581ad593c6e..0000000000000000000000000000000000000000 --- a/README.txt +++ /dev/null @@ -1,23 +0,0 @@ -(* OASIS_START *) -(* DO NOT EDIT (digest: 60e4b12af94a3d68c3266a56d99b4774) *) - -lustre-v6 - The Lustre V6 Verimag compiler -========================================== - -This package contains: - lv6: the (current) name of the compiler (and -interpreter via -exec) - the lustre-v6 ocaml lib: allows to call the Lustre -v6 interpreter from ocaml - the lustre-v6 rdbg plugin: allows to debug Lustre -v6 program wth rdbg - -See the file [INSTALL.txt](INSTALL.txt) for building and installation -instructions. - -[Home page](http://www-verimag.imag.fr/lustre-v6.html) - -Copyright and license ---------------------- - -lustre-v6 is distributed under the terms of the CEA-CNRS-INRIA Logiciel -Libre. - -(* OASIS_STOP *) diff --git a/lustre-v6.install b/lustre-v6.install index 622ada402df1784276cba45ac58e232a35f767c6..b400a30f615d567958f1baf9fdadcecade751758 100644 --- a/lustre-v6.install +++ b/lustre-v6.install @@ -394,5 +394,6 @@ bin: [ ] doc: [ "_build/install/default/doc/lustre-v6/LICENSE" - "_build/install/default/doc/lustre-v6/README.txt" + "_build/install/default/doc/lustre-v6/README.md" + "_build/install/default/doc/lustre-v6/README.org" ]