Commit 19e29bfe authored by erwan's avatar erwan
Browse files

Doc: Add a README.org and remove old oasis generated files

parent a4b2a53a
(* 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 *)
(* 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
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
-----
(* 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 *)
......@@ -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"
]
Supports Markdown
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