1- # Portable MLIR Toolchain
1+ # setup-mlir
22
3- This repository aims to streamline the setup of the MLIR toolchain .
3+ This repository provides an action for setting up MLIR in GitHub Actions and installation scripts for setting up MLIR locally .
44
5- ## GitHub Action
5+ The MLIR binaries are built and distributed in the [ ` portable-mlir-toolchain ` ] ( https://github.com/munich-quantum-software/setup-mlir/ ) repository.
66
7- We provide a GitHub Action.
7+ ## GitHub Actions
88
99``` yaml
1010- name : Setup MLIR
@@ -14,35 +14,20 @@ We provide a GitHub Action.
1414` ` `
1515
1616This extracts a pre-built MLIR installation, adds the binaries to ` $PATH`, and defines `$LLVM_DIR` and `$MLIR_DIR`.
17- The pre-built MLIR installation can be found in the release assets on GitHub.
18- We are using calendar versioning for our releases.
19- Refer to the release notes of the respective release for information on the LLVM version and the build settings.
2017
2118# # Installation Scripts
2219
2320If you want to use the pre-built MLIR installations locally, we also provide installation scripts.
2421The scripts require the LLVM version (e.g., `21.1.7`) and the desired installation directory to be passed.
2522
26- On Linux and macOS, use the following to run the installation script :
23+ On Linux and macOS, use the following Bash command :
2724
2825` ` ` bash
2926curl -LsSf https://github.com/munich-quantum-software/setup-mlir/releases/latest/download/setup-mlir.sh | bash -s -- -v 21.1.7 -p /path/to/installation
3027` ` `
3128
32- On Windows, use this PowerShell command :
29+ On Windows, use the following PowerShell command :
3330
3431` ` ` powershell
3532powershell -ExecutionPolicy ByPass -c "irm https://github.com/munich-quantum-software/setup-mlir/releases/latest/download/setup-mlir.ps1 | iex; setup-mlir.ps1 -llvm_version 21.1.7 -install_prefix /path/to/installation"
3633` ` `
37-
38- # # Build Scripts
39-
40- If desired, you can also use our build scripts directly.
41- Refer to
42-
43- - [`scripts/toolchain/linux/build.sh`](./scripts/toolchain/linux/build.sh) for Linux,
44- - [`scripts/toolchain/macos/build.sh`](./scripts/toolchain/macos/build.sh) for macOS, and
45- - [`scripts/toolchain/windows/build.ps1`](./scripts/toolchain/windows/build.ps1) for Windows.
46-
47- The usage is detailed in the scripts.
48- Note that the Linux script requires Docker to be installed on the host system.
0 commit comments