From 0f1337d4ec20112b609192e0559ad3f1228f5aff Mon Sep 17 00:00:00 2001 From: Pierrot Date: Thu, 22 Aug 2024 15:10:10 +0200 Subject: [PATCH] Add documentation for Windows support (#1216) * Add documentation for Windows support This commit adds documentation for installing AE on Windows with opam 2.2. --- docs/sphinx_docs/Install/index.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/sphinx_docs/Install/index.md b/docs/sphinx_docs/Install/index.md index 11f09fff1..86c68c54c 100644 --- a/docs/sphinx_docs/Install/index.md +++ b/docs/sphinx_docs/Install/index.md @@ -7,14 +7,9 @@ Alt-ergo is available on [opam], the ocaml package manager with the following co opam install alt-ergo ``` -This two command will install the Alt-ergo library `alt-ergo-lib` and the parsers `alt-ergo-parsers`, as well as other librairies detailled in [dependencies](#dependencies). +This command will install the Alt-ergo library `alt-ergo-lib` and the parsers `alt-ergo-parsers`, as well as other librairies detailled in [dependencies](#dependencies). -## From GitHub releases (Linux and macOS) - -For convenience, binary releases for Linux and macOS (amd64 and arm64) of -Alt-Ergo are provided on the GitHub release page. These binary releases are -statically linked and very portable. They are distributed under the same -licensing restrictions as the source code. +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/). ### On Debian @@ -24,6 +19,13 @@ Alt-ergo is also available in the debian package manager [here]. You can install sudo apt install alt-ergo ``` +## From GitHub releases (Linux and macOS) + +For convenience, binary releases for Linux and macOS (amd64 and arm64) of +Alt-Ergo are provided on the GitHub release page. These binary releases are +statically linked and very portable. They are distributed under the same +licensing restrictions as the source code. + ## From sources ### Dependencies