diff --git a/README.md b/README.md index 9b91013..063afd1 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,26 @@ The Constrained and Unconstrained Testing Environment with safe threads (CUTEst) See the [wiki](https://github.com/ralna/CUTEst/wiki) for download and installation instructions - +[![Build Status](https://img.shields.io/github/actions/workflow/status/ralna/CUTEst/ci.yml?branch=master)](https://github.com/ralna/SIFDecode/actions/workflows/ci.yml) [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) + +## Installation + +### Precompiled library and executables + +We provide precompiled CUTEst libraries and executables in the [releases tab](https://github.com/ralna/SIFDecode/releases/latest/) for Linux, macOS (Intel & Silicon) and Windows. + +### Installation from source + +CUTEst can be installed using the [Meson build system](https://mesonbuild.com) (all commands below are to be run from the top of the source tree): + +```shell +meson setup builddir +meson compile -C builddir +meson install -C builddir +meson test -C builddir +``` + +CUTEst can also be installed via the "make" build system based on [ARCHDefs](https://github.com/ralna/ARCHDefs). +To use this variant, follow the instructions in the CUTEst [wiki](https://github.com/ralna/CUTEst/wiki).