|
1 | 1 | # Installation |
2 | 2 |
|
3 | | -## From a package manager |
| 3 | +# Releases |
4 | 4 |
|
5 | | -Alt-ergo is available on [opam], the ocaml package manager with the following command : |
| 5 | +## From opam |
| 6 | +The recommended way to install Alt-Ergo releases is via the OCaml package |
| 7 | +manager [opam]. Simply run: |
6 | 8 | ```console |
7 | 9 | opam install alt-ergo |
8 | 10 | ``` |
| 11 | +to install Alt-Ergo in the current switch. |
9 | 12 |
|
10 | | -This command will install the Alt-ergo library `alt-ergo-lib`, as well as other librairies detailled in [dependencies](#dependencies). |
| 13 | +## From GitHub releases (Linux and macOS) |
| 14 | +For convenience, binary releases for Linux and macOS (amd64 and arm64) of |
| 15 | +Alt-Ergo are provided on the [GitHub release page](https://github.com/OCamlPro/alt-ergo/releases). |
| 16 | +These binary releases are statically linked and very portable. |
| 17 | +They are distributed under the same licensing restrictions as the source code. |
11 | 18 |
|
12 | | -Since version 2.6.0, Alt-Ergo is compatible with opam 2.2 installations using both Cygwin and MSYS2 on Windows. To setup opam on Windows, please follow the instructions [here](https://ocamlpro.com/blog/2024_07_01_opam_2_2_0_releases/). |
| 19 | +# Development versions |
13 | 20 |
|
14 | | -## From GitHub releases (Linux and macOS) |
| 21 | +## From opam |
| 22 | +In the git directory, run: |
| 23 | +``` |
| 24 | +opam install . |
| 25 | +``` |
| 26 | +to install `alt-ergo`, `alt-ergo-lib` and all their dependencies in the current |
| 27 | +switch. |
15 | 28 |
|
16 | | -For convenience, binary releases for Linux and macOS (amd64 and arm64) of |
17 | | -Alt-Ergo are provided on the GitHub release page. These binary releases are |
18 | | -statically linked and very portable. They are distributed under the same |
19 | | -licensing restrictions as the source code. |
| 29 | +## From dune |
| 30 | +If you prefer install Alt-Ergo binary in a specific prefix directory [DIR], run |
| 31 | +``` |
| 32 | +make deps |
| 33 | +make bin |
| 34 | +dune install -p alt-ergo --prefix DIR |
| 35 | +``` |
| 36 | +and |
| 37 | +``` |
| 38 | +dune uninstall -p alt-ergo --prefix DIR |
| 39 | +``` |
| 40 | +For the Alt-Ergo library |
20 | 41 |
|
| 42 | +``` |
| 43 | +make deps |
| 44 | +make lib |
| 45 | +dune install -p alt-ergo-lib --prefix DIR |
| 46 | +``` |
| 47 | +and |
| 48 | +``` |
| 49 | +dune uninstall -p alt-ergo-lib --prefix DIR |
| 50 | +``` |
21 | 51 | ## From sources |
22 | 52 |
|
23 | 53 | ### Dependencies |
|
0 commit comments