Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
caisar
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
pub
caisar
Commits
778db61b
Commit
778db61b
authored
2 years ago
by
Julien Girard-Satabin
Committed by
Michele Alberti
2 years ago
Browse files
Options
Downloads
Patches
Plain Diff
[doc] Updated installation instructions.
parent
2469cc2c
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc/installation.rst
+47
-14
47 additions, 14 deletions
doc/installation.rst
with
47 additions
and
14 deletions
doc/installation.rst
+
47
−
14
View file @
778db61b
...
@@ -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.
I
nstall
external dependencies::
:
To i
nstall
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``
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment