Skip to content
Snippets Groups Projects
Commit 778db61b authored by Julien Girard-Satabin's avatar Julien Girard-Satabin Committed by Michele Alberti
Browse files

[doc] Updated installation instructions.

parent 2469cc2c
No related branches found
No related tags found
No related merge requests found
...@@ -3,25 +3,58 @@ ...@@ -3,25 +3,58 @@
Installation Installation
============ ============
For now, no binaries are provided. Installation must be made The latest release of CAISAR is available as an
directly by compiling the source. `opam <https://opam.ocaml.org/>`_ package or
It requires Ocaml package manager Opam, v2.1 or higher. a `Docker <https://www.docker.com/>`_ image.
The development version of CAISAR is available only by compiling the source code.
For development, it is recommended you set-up your own Install through Opam
Opam switch (an OCaml installation isolated from system --------------------
libraries)::
git clone https://git.frama-c.com/pub/laiser/caisar.git && cd caisar **Please note:** CAISAR requires the OCaml package manager
opam switch create --yes --no-install . ocaml-base-compiler.4.13.1 (Opam) v2.1 or higher, which is typically avaible in all major
GNU/Linux distributions.
Install external dependencies::: To install CAISAR via opam, do the following:
opam depext --yes ocplib-endian base fmt alt-ergo.2.4.0 ``$ opam install caisar``
opam install . --deps-only --with-test --yes
Finally, run the compilation and the unit tests::: Install through Docker
----------------------
make This method requires Docker to be installed in your system.
make test A ready-to-use Docker image of CAISAR is available on
`Docker Hub <https://hub.docker.com>`_. To retrieve it, do the
following:
``$ docker pull laiser/caisar:pub``
Alternatively, a Docker image for CAISAR can be
created locally by proceeding as follows:
::
$ git clone https://git.frama-c.com/pub/caisar
$ cd caisar
$ make docker
To run the CAISAR Docker image, do the following:
``$ docker run -it laiser/caisar:pub sh``
Compile from source
-------------------
To build and install CAISAR, do the following:
::
$ git clone https://git.frama-c.com/pub/caisar
$ cd caisar
$ opam switch create --yes --no-install . 4.13.1
$ opam install . --deps-only --with-test --yes
$ make
$ make install
To run the tests:
``$ make test``
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment