Skip to content

Commit fb3848e

Browse files
committed
Improve the installation documentation
1 parent 0a73eab commit fb3848e

File tree

5 files changed

+24
-221
lines changed

5 files changed

+24
-221
lines changed

doc/pages/Distribution.md

-126
This file was deleted.

doc/pages/Install.md

+22-94
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ We provide pre-compiled binaries for:
4343
- macOS (amd64, arm64)
4444
- FreeBSD (amd64)
4545
- OpenBSD (amd64)
46+
- NetBSD (amd64)
4647
- Windows (amd64)
4748
(other platforms are available using the other methods below)
4849

@@ -60,114 +61,58 @@ sudo install <downloaded file> /usr/local/bin/opam
6061
6162
## Using your system's package manager
6263

63-
This is generally the recommended way, **when available and up-to-date** (you
64-
can check [here](Distribution.html) the latest
65-
available release per distribution). Here is a list of supported distributions:
64+
This is generally the recommended way, **when available and up-to-date**. You
65+
can check the following table:
6666

67-
#### Arch Linux
67+
[![repology package status](https://repology.org/badge/vertical-allrepos/opam.svg?exclude_unsupported=1)](https://repology.org/project/opam/versions)
6868

69-
[![badge](https://repology.org/badge/version-for-repo/arch/opam.svg)](https://repology.org/project/opam/versions)
69+
If your distribution is up-to-date you can install opam the following way:
7070

71-
The [opam](https://www.archlinux.org/packages/extra/x86_64/opam/)
72-
package is available in the official distribution. To install it simply run:
71+
#### Arch Linux
7372

7473
```
7574
pacman -S opam
7675
```
7776

78-
If you'd like to use the development version there is an [opam-git](https://aur.archlinux.org/packages/opam-git/)
79-
package available in the [AUR](https://wiki.archlinux.org/index.php/Arch_User_Repository).
80-
Assuming you have [yay](https://github.com/Jguer/yay) installed just run the following command:
81-
82-
```
83-
yay -S opam-git
84-
```
85-
86-
#### Debian
77+
#### Debian and Ubuntu
8778

88-
[![badge](https://repology.org/badge/version-for-repo/debian_stable/opam.svg)](https://repology.org/project/opam/versions) [![badge](https://repology.org/badge/version-for-repo/debian_testing/opam.svg)](https://repology.org/project/opam/versions) [![badge](https://repology.org/badge/version-for-repo/debian_unstable/opam.svg)](https://repology.org/project/opam/versions)
89-
90-
Binary packages of opam are available for the
91-
[stable](http://packages.debian.org/jessie/opam),
92-
[testing](http://packages.debian.org/stretch/opam) and
93-
[unstable](http://packages.debian.org/sid/opam) distributions, from the official
94-
repositories. You should be set with:
95-
96-
```
97-
apt-get install opam
9879
```
99-
100-
#### [Exherbo](http://exherbo.org)
101-
102-
The
103-
[`dev-ocaml/opam`](http://git.exherbo.org/summer/packages/dev-ocaml/opam/index.html)
104-
package can be installed with the command:
105-
106-
```
107-
cave resolve -x dev-ocaml/opam
80+
apt install opam
10881
```
10982

110-
You might need to add the `::ocaml-unofficial` repository first:
111-
112-
```
113-
cave resolve -x repository/ocaml-unofficial
114-
```
115-
116-
#### [Fedora](http://fedoraproject.org), [CentOS](http://centos.org) and RHEL
117-
118-
[![Fedora 39](https://repology.org/badge/version-for-repo/fedora_39/opam.svg)](https://repology.org/project/opam/versions)
119-
120-
The opam package for Fedora can be installed with the command:
83+
#### Fedora
12184

12285
```
12386
dnf install opam
12487
```
12588

126-
There is not currently a package for CentOS/RHEL. You will need to use our
127-
pre-built binaries, or build from sources.
128-
12989
#### Mageia
13090

131-
[![badge](https://repology.org/badge/version-for-repo/mageia_cauldron/opam.svg)](https://repology.org/project/opam/versions)
132-
133-
The opam package for Mageia can be installed with the command:
134-
13591
```
13692
urpmi opam
13793
```
13894

139-
#### OpenBSD
95+
#### Alpine Linux
14096

141-
[![badge](https://repology.org/badge/version-for-repo/openbsd/opam.svg)](https://repology.org/project/opam/versions)
97+
```
98+
apk add opam
99+
```
142100

143-
The opam package for OpenBSD can be installed with the command (since OpenBSD 5.7):
101+
#### OpenBSD
144102

145103
```
146104
pkg_add opam
147105
```
148106

149107
#### FreeBSD
150108

151-
[![badge](https://repology.org/badge/version-for-repo/freebsd/opam.svg)](https://repology.org/project/opam/versions)
152-
153-
Opam is available in the ports and packages tree on FreeBSD 11 or higher.
154-
155109
```
156110
pkg install ocaml-opam
157111
```
158112

159-
or to install from source:
160-
161-
```
162-
cd /usr/ports/devel/ocaml-opam
163-
make install
164-
```
165-
166113
#### macOS
167114

168-
[![badge](https://repology.org/badge/version-for-repo/homebrew/opam.svg)](https://repology.org/project/opam/versions) [![badge](https://repology.org/badge/version-for-repo/macports/opam.svg)](https://repology.org/project/opam/versions)
169-
170-
Opam packages for [homebrew](http://mxcl.github.com/homebrew/) and [MacPorts](http://www.macports.org/) are available.
115+
Opam packages for [Homebrew](https://brew.sh/) and [MacPorts](http://www.macports.org/) are available.
171116

172117
```
173118
# Homebrew
@@ -177,37 +122,21 @@ brew install opam
177122
port install opam
178123
```
179124

180-
See also
181-
[howto setup Emacs.app](https://github.com/ocaml/opam/wiki/Setup-Emacs.app-on-macosx-for-opam-usage)
182-
for Opam usage.
183-
184-
#### Ubuntu
185-
186-
[![badge](https://repology.org/badge/version-for-repo/ubuntu_24_04/opam.svg)](https://repology.org/project/opam/versions)
187-
188-
```
189-
apt install opam
190-
```
191-
192125
#### Guix & Guix System
193126

194-
[![badge](https://repology.org/badge/version-for-repo/gnuguix/opam.svg)](https://repology.org/project/opam/versions)
195-
196-
The opam package for [guix](https://www.gnu.org/software/guix/) can be installed with the command:
197-
198127
```
199-
# Guix
200128
guix install opam
201129
```
202130

203131
#### Windows
204132

205-
[![badge](https://repology.org/badge/version-for-repo/winget/opam.svg)](https://repology.org/project/opam/versions)
206-
207133
```
208134
winget install Git.Git OCaml.opam
209135
```
210136

137+
WinGet the Windows Package Manager is available on Windows 11, modern versions of Windows 10, and Windows Server 2025.
138+
See the [official documentation](https://learn.microsoft.com/en-us/windows/package-manager/winget/) for additional info.
139+
211140
## From Sources
212141

213142
#### Getting the Sources
@@ -217,12 +146,11 @@ Sources of the latest stable version of opam are available on Github:
217146
* [Opam releases on Github](https://github.com/ocaml/opam/releases)
218147

219148
You can also download the full archives, including opam dependencies (these
220-
don't require any extra downloads, just the OCaml compiler -- 4.02.3 or later
221-
for the latest version):
149+
don't require any extra downloads):
222150

223-
* [2.2.0](https://github.com/ocaml/opam/releases/download/2.2.0/opam-full-2.2.0-2.tar.gz)
224-
- MD5: ba94fd83c0e023b0d3c91857f28b8755
225-
- SHA384: 365eb949bfe18d0f189b35e620fa854628ab3e962721ee43488865456bf80da0dbba037b8fdb3830abb83f64b7c79106
151+
* [2.3.0](https://github.com/ocaml/opam/releases/download/2.3.0/opam-full-2.3.0.tar.gz)
152+
- MD5: 81d029c2b79c53f4d99005df47696bef
153+
- SHA384: 7c62af375f7fc293236f5ce49c51957f39356a937a578683a79fbe1a3ed9e96b64d97c369206923248cbec62c4c251dc
226154

227155
Follow the instructions in the included
228156
[`README.md`](https://github.com/ocaml/opam#readme) to get opam built and

doc/pages/index.menu

-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ Usage.md
1212
FAQ.md
1313
Tricks.md
1414
Packaging.md
15-
Distribution.md
1615
External_solvers.md
1716

1817
Manual.md

master_changes.md

+1
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,7 @@ users)
189189
* Manual: add information when flags (`avoid-version`, `deprecated`) were introduced [#6320 @hannesm]
190190
* Add winget command for installing opam [#6338 @tobil4sk]
191191
* Fix broken link to non-existing archlinux community repo [#6361 @juergenhoetzel]
192+
* Improve the installation documentation [#6372 @kit-ty-kate]
192193

193194
## Security fixes
194195

release/readme.md

+1
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
* finalise the release (publish)
3939
* add hashes in `install.sh` and `install.ps1` (and check signatures)
4040
* bring the changes to the changelog (CHANGES) from the branch of the release to the `master` branch
41+
* Update doc/pages/Install.md
4142
* publish opam packages in opam-repository (use `opam publish --pre-release` if this is not a stable version)
4243
* update versions (and messages, if necessary) in https://github.com/ocaml/opam-repository/blob/master/repo
4344

0 commit comments

Comments
 (0)