diff --git a/manual/INSTALL b/manual/INSTALL new file mode 100644 index 0000000..426be8c --- /dev/null +++ b/manual/INSTALL @@ -0,0 +1,72 @@ + ################################################# + # # + # Heptagon/BZR : compilation and installation # + # # + ################################################# + + +Required tools +-------------- + +The use of the Heptagon compiler by itself does not require any +additional tools. However, the usual use involves a compiler for the +generated code (e.g., gcc for C generated code, or javac for Java). + +The tools below are optional or are related to some subparts of +Heptagon: +- The graphical display tool sim2chro can be obtained from Verimag + [1]. It can be used together with the graphical simulator hepts. +- The Sigali tool [2] for model-checking and discrete controller + synthesis is mandatory for the use of contracts. Sigali can be + downloaded on the BZR website : http://bzr.inria.fr. + + + +Compilation and installation +---------------------------- + +* Required libraries and tools for the compilation + +The compilation of the Heptagon compiler requires: +- OCaml [3] (version >= 3.11), and the ocamlbuild and ocamlfind tools +- the Menhir [4] parser generator +- the ocamlgraph [5] library. + +The compilation of the Heptagon simulator (optional) requires the +LablGTK2 [6] library. + + +* Compilation + +Once the compiler is downloaded and untarred, go into the heptagon/ +directory and type : + +$ ./configure && make + +This command will build the compiler, optionally the simulator (if the +LablGTK2 library is found), and the standard library. + + +* Installation + +After the compilation, or the download and untar of the binary +distribution, go into the heptagon/ directory and type : + +$ make install + +By default, this will install the binaries (heptc and hepts) into +/usr/local/bin and the standard library into +/usr/local/lib. Consider the configure script options +(./configure --help) for other specific needs. + + + +URLs +---- + +[1] sim2chro : http://www-verimag.imag.fr/~raymond/edu/distrib +[2] Sigali : http://www.irisa.fr/vertecs/Logiciels/sigali.html +[3] OCaml : http://caml.inria.fr +[4] Menhir : http://gallium.inria.fr/~fpottier/menhir/ +[5] ocamlgraph : http://ocamlgraph.lri.fr +[6] LablGTK2 : http://wwwfun.kurims.kyoto-u.ac.jp/soft/lsl/lablgtk.html diff --git a/manual/heptagon-manual.tex b/manual/heptagon-manual.tex index f665587..f791626 100644 --- a/manual/heptagon-manual.tex +++ b/manual/heptagon-manual.tex @@ -124,8 +124,8 @@ library. \subsubsection{Compilation} \label{sec:compilation} -Once the compiler is downloaded and untarred, go into the \texttt{heptagon/} and -type : +Once the compiler is downloaded and untarred, go into the \texttt{heptagon/} +directory and type : \begin{alltt} > ./configure && make