Skip to main content

Installation

You can choose to install crs from either:

  • Pre-compiled binaries from GitHub releases (see Pre-compiled Binaries)
  • The public opam-repository (most stable releases)
  • A custom opam-repository (more frequent releases)
  • From source (most recent version, PRs, etc.)
  • GitHub Actions (see Setup crs for GitHub Actions)

Releases are currently versioned using the scheme 0.0.YYYMMDD while we are in the early stages of development.

Pre-compiled Binaries​

Pre-compiled binaries are available for select architectures from GitHub releases. This is the fastest installation method if your architecture is supported. See Pre-compiled Binaries for download and verification instructions.

For an explanation of why we distribute binaries this way, see Binary Distribution.

Release Process​

The exact rate at which we publish new versions during the early stages of the project is not really established yet. We'd like to find a balance that feels right between making sure new features and bug fixes are continuously delivered to people experimenting with the project on one hand, but not publishing too many intermediate versions to the public opam repository on the other hand.

The way in which we propose to do this with this project is that we publish somewhat frequent releases of the project to a custom opam-repository. In particular note that not every release that is published that way will make it into a public release - we will skip some, and only publish a public release every so often.

Finally, if you'd like to try or test the latest current version, or the tip of an ongoing PR, you may build from source.

From the Public Opam Repository​

Public releases of crs are published to the main opam-repository. Install it with the opam package manager by running:

opam install crs

Note that crs needs to be installed in a switch with ocaml >= 5.2.

From the Custom Opam Repository​

Intermediate releases for this project are published to a custom opam-repo. To add it to your current opam switch, run:

opam repo add mbarbin https://github.com/mbarbin/opam-repository.git

Then you can install crs using a normal opam workflow:

opam install crs

Build from Sources​

Assuming you have a working environment with OCaml >= 5.2, opam and dune you should be able to install the project's dependencies in your current opam switch by running:

opam install . --deps-only

And then build with:

dune build

Unreleased Packages​

From time to time, the project may have temporary dependencies on packages that are being worked on and perhaps not yet published to the main opam repository. When this is the case, these packages are released to the custom opam repository mentioned earlier, and you'll need to add it to the opam switch that you use to build the project.

For example, if you use a local opam switch, this would look like this:

git clone https://github.com/mbarbin/crs.git
cd crs
opam switch create . 5.3.0 --no-install
eval $(opam env)
opam repo add mbarbin https://github.com/mbarbin/opam-repository.git
opam install . --deps-only

Once this is setup, you can build with dune:

dune build

GitHub Actions​

If you're looking to install crs within a GitHub Actions workflow, please see Setup crs for GitHub Actions for the recommended approach using the setup-crs action.