Skip to content

chore: Update DEVELOPMENT.md with LLVM 21 setup instructions #2935

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aborgna-q merged 2 commits into from
Mar 16, 2026
Merged

chore: Update DEVELOPMENT.md with LLVM 21 setup instructions #2935

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
122e1f4
chore: Update DEVELOPMENT.md with LLVM 21 instructions
aborgna-q Mar 10, 2026
286d91a
review comments
aborgna-q Mar 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ To setup the environment manually you will need:
- uv `>=0.7`: <https://docs.astral.sh/uv/getting-started/installation>
- Optional: capnproto `>=1.0`: <https://capnproto.org/install.html>
Required when modifying the `hugr-model` serialization schema.
- Optional: llvm `== 14.0`. The "llvm" feature (backed by the sub-crate `hugr-llvm`)
requires LLVM installed. We use the rust bindings
[llvm-sys](https://crates.io/crates/llvm-sys) to [llvm](https://llvm.org/).
- Optional: [llvm](https://llvm.org/) `== 21.1`. The "llvm" feature (backed by the sub-crate `hugr-llvm`)
requires LLVM 21.1 installed. We use the rust bindings from
[llvm-sys](https://crates.io/crates/llvm-sys).

Once you have these installed, you can install the required python dependencies and setup pre-commit hooks with:

Expand All @@ -46,11 +46,11 @@ just setup

#### Note on LLVM

You will need llvm 14.0 installed in order for `just check` to run all its
You will need llvm 21.1 installed in order for `just check` to run all its
checks successfully. On Debian-based systems you can install it as the
`llvm-14` package; you will also need to install `libpolly14-dev`. You should
set the environment variable `LLVM_SYS_140_PREFIX` to point to its location
(e.g. `/usr/lib/llvm-14`) when running `just check`.
`llvm-21` package; you may also need to install `libpolly21-dev`. You should
set the environment variable `LLVM_SYS_211_PREFIX` to point to its location
(e.g. `/usr/lib/llvm-21`) when running `just check`.

## 🏃 Running the tests

Expand Down
Loading