Skip to content

Commit

Permalink
Update the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
amontoison authored and jfowkes committed Oct 8, 2024
1 parent 19e7c2b commit 527a2d7
Showing 1 changed file with 29 additions and 3 deletions.
32 changes: 29 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,34 @@ 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://travis-ci.org/ralna/CUTEst.svg?branch=master)](https://travis-ci.org/ralna/CUTEst)
-->
[![Build Status](https://img.shields.io/github/actions/workflow/status/ralna/CUTEst/ci.yml?branch=master)](https://github.com/ralna/CUTEst/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 libraries 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).

## Interfaces

- [CUTEst.jl](https://github.com/JuliaSmoothOptimizers/CUTEst.jl) is the Julia interface of CUTEst.

- [PyCUTEst](https://github.com/jfowkes/pycutest) is the Python interface of CUTEst.

- [MatCUTEst](https://github.com/matcutest/matcutest) is the MATLAB interface of CUTEst.

0 comments on commit 527a2d7

Please sign in to comment.