Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for Windows support #1216

Merged
merged 2 commits into from
Aug 22, 2024
Merged

Add documentation for Windows support #1216

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9db704f
Add documentation for Windows support
Halbaroth Aug 8, 2024
667777a
review changes
Halbaroth Aug 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions docs/sphinx_docs/Install/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 officially supported on Windows through opam 2.2 with both Cygwin and MSYS2. To setup opam on Windows, please follow the instructions [here](https://ocamlpro.com/blog/2024_07_01_opam_2_2_0_releases/).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Since version 2.6.0, Alt-Ergo is officially supported on Windows through opam 2.2 with both Cygwin and MSYS2. To setup opam on Windows, please follow the instructions [here](https://ocamlpro.com/blog/2024_07_01_opam_2_2_0_releases/).
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/).

Doesn't hurt to be cautious about the amount of Windows-specific support we can commit to.

Copy link
Collaborator Author

@Halbaroth Halbaroth Aug 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By officially supported I mean we will do the efforts to fix them ;) You think it is too bold?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand; I am saying I am not sure we have the resources to commit to fixing Windows-specific issues (not that we won't fix them, but I'd be cautious about promising we will, even implicitly).


### On Debian

Expand All @@ -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
Expand Down
Loading