Skip to content

Commit 0770fb0

Browse files
committed
Add instructions for how to install mise
1 parent 70b2cfd commit 0770fb0

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -425,6 +425,36 @@ mise run test
425425
mise run postgres:down
426426
```
427427

428+
### Installing mise
429+
430+
> [!IMPORTANT]
431+
> You must complete this step to set up a local development environment.
432+
433+
Local development and task running in CI is managed through [mise](https://mise.jdx.dev/).
434+
435+
To install mise:
436+
437+
- If you're on macOS, run `brew install mise`
438+
- If you're on another platform, check out the mise [installation methods documentation](https://mise.jdx.dev/installing-mise.html#installation-methods)
439+
440+
Then add mise to your shell:
441+
442+
```shell
443+
# If you're running Bash
444+
echo 'eval "$(mise activate bash)"' >> ~/.bashrc
445+
446+
# If you're running Zsh
447+
echo 'eval "$(mise activate zsh)"' >> ~/.zshrc
448+
```
449+
450+
We use [`cargo-binstall`](https://github.com/cargo-bins/cargo-binstall) for faster installation of tools installed via `mise` and Cargo.
451+
We install `cargo-binstall` via `mise` when installing development and testing dependencies.
452+
453+
> [!TIP]
454+
> We provide abbreviations for most of the commands that follow.
455+
> For example, `mise run postgres:setup` can be abbreviated to `mise r s`.
456+
> Run `mise tasks --extended` to see the task shortcuts.
457+
428458
### How this project is organised
429459

430460
Development is managed through [mise](https://mise.jdx.dev/), both locally and [in CI](https://github.com/cipherstash/encrypt-query-language/actions).

0 commit comments

Comments
 (0)