Skip to content

Commit

Permalink
doc: update README install guide
Browse files Browse the repository at this point in the history
  • Loading branch information
martinjrobins committed Jan 3, 2025
1 parent b3b532f commit 71162a5
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ If you are writing your own ode solver and want to make use of the DiffSL compil

## Dependencies

You will need to install the [LLVM project](https://llvm.org/). The easiest way to
To use the llvm backend (optional) You will need to install the [LLVM project](https://llvm.org/). The easiest way to
install this is to use the package manager for your operating system. For
example, on Ubuntu you can install these with the following command:

Expand All @@ -88,12 +88,12 @@ sudo apt-get install llvm

## Installation

You can install DiffSL using cargo. You will need to indicate the llvm version you have installed using a feature flag. For example, for llvm 14:
You can install DiffSL using cargo. By default the cranelift backend will be used. To use the llvm backend (which generates more optimised code), you will need to indicate the llvm version you have installed using a feature flag. For example, for llvm 16:

```bash
cargo add diffsl --features llvm14-0
cargo add diffsl --features llvm16-0
```

Other versions of llvm are also supported given by the features `llvm13-0`, `llvm14-0`, `llvm15-0`, `llvm16-0`, `llvm17-0`.
Other versions of llvm are also supported given by the features `llvm15-0`, `llvm16-0`, `llvm17-0`, `llvm18-0`.


0 comments on commit 71162a5

Please sign in to comment.