Skip to content

Commit 184de13

Browse files
committed
Update documentation
1 parent eb9416b commit 184de13

3 files changed

Lines changed: 12 additions & 3 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,13 @@ Packaging `celq` for Linux, macOS, and Windows is a welcome contribution. If you
5050

5151
## MSRV
5252

53-
The Minimum Supported Rust Version (MSRV) of `celq` trys to align with the MSRV of Debian testing and FreeBSD ports.
53+
The Minimum Supported Rust Version (MSRV) of `celq` trys to align with the MSRV of Debian testing, FreeBSD ports, and OpenBSD.
5454

5555
To see their current MSRV, search for:
5656
* [rustc in Debian Packages](https://packages.debian.org/search?keywords=rustc) and see the version listed for testing.
57-
* [lang/rust in FreeBSD ports](https://www.freshports.org/lang/rust) and see the version listed for quarterly releases for `amd64`
57+
* [lang/rust in FreeBSD ports](https://www.freshports.org/lang/rust) and see the version listed for quarterly releases for `amd64` and `aarch64`
58+
* [ports/lang/rust in OpenBSD ports](https://cvsweb.openbsd.org/ports/lang/rust/Makefile) and see the latest version with a `CVS Tags` of the format `OPENBSD_X_Y`
5859

5960
We use the minimum version among the two.
6061

61-
Notice that eventually that may lag behind the latest of rustc by a considerable margin. However, that guarantees that `celq` can be packaged by many Linux distributions and FreeBSD.
62+
Notice that eventually that may lag behind the latest of rustc by a considerable margin. However, that guarantees that `celq` can be packaged by many Linux distributions, FreeBSD, and OpenBSD.

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,10 @@ su root -c 'install -m 755 celq /usr/local/bin/'
156156

157157
`celq` can also be installed from source following the [Cargo](#cargo) section. We strive to always compile with the Rust version provided in the ports tree.
158158

159+
### OpenBSD
160+
161+
OpenBSD builds are tested in CI using the latest stable release. `celq` strives to always compile with the Rust version provided in the ports tree. Refer to the [Cargo](#cargo) section for instructions.
162+
159163
### NPM (Node.js/JavaScript)
160164

161165
`celq` is packaged for [NPM](https://www.npmjs.com/package/celq). Node.js users can install celq in their project with:

docs/installation_guide.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,10 @@ su root -c 'install -m 755 celq /usr/local/bin/'
166166

167167
`celq` can also be installed from source following the [Cargo](#cargo) section. We strive to always compile with the Rust version provided in the ports tree.
168168

169+
### OpenBSD
170+
171+
OpenBSD builds are tested in CI using the latest stable release. `celq` strives to always compile with the Rust version provided in the ports tree. Refer to the [Cargo](#cargo) section for instructions.
172+
169173
### NPM (Node.js/JavaScript)
170174

171175
`celq` is packaged for [NPM](https://www.npmjs.com/package/celq). Node.js users can install celq in their project with:

0 commit comments

Comments
 (0)