Skip to content

Commit ddc4ed0

Browse files
Document mise alongside asdf and link toolchain check task
Linux getting started treats mise and asdf equally for .tool-versions, explains manager-agnostic shell wrappers, and documents mix desktop.check_toolchain. README notes contributor toolchain pinning. Refs #67 Co-authored-by: Dominic Letz <dominicletz@users.noreply.github.com>
1 parent 7800991 commit ddc4ed0

2 files changed

Lines changed: 25 additions & 2 deletions

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ Checkout [the example app](https://github.com/elixir-desktop/desktop-example-app
1616

1717
## Getting Started
1818

19-
Check out the [Getting your Environment Ready Guide](./guides/getting_started.md) and [Your first Desktop App](./guides/your_first_desktop_app.md)
19+
Check out the [Getting your Environment Ready Guide](./guides/getting_started.md) and [Your first Desktop App](./guides/your_first_desktop_app.md).
20+
21+
This repo’s [`.tool-versions`](./.tool-versions) pins Erlang and Elixir for contributors; [mise](https://mise.jdx.dev/) and [asdf](https://asdf-vm.com/) both understand that file. After activating your toolchain, run `mix desktop.check_toolchain` to confirm the running OTP major and Elixir version match `.tool-versions`.
2022

2123
## Status / Roadmap
2224

guides/getting_started.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,10 +121,31 @@ echo ". ~/maint-24/activate" >> ~/.bashrc
121121

122122
Best to use Erlang solutions packages: https://www.erlang-solutions.com/downloads/
123123

124-
**Or use ASDF**
124+
### Version managers (optional)
125+
126+
Many projects pin Erlang and Elixir with a **`.tool-versions`** file (same format works with [mise](https://mise.jdx.dev/) and [asdf](https://asdf-vm.com/)). Pick either tool—your shell only needs the correct `erl` / `elixir` on `PATH` when you run `mix`.
127+
128+
**mise** (example):
129+
130+
```bash
131+
curl https://mise.run | sh
132+
mise install
125133
```
134+
135+
**asdf** (example):
136+
137+
```bash
126138
asdf plugin update --all
127139
asdf install erlang 24.0.1
140+
asdf install elixir 1.14.0-otp-24
141+
```
142+
143+
Shell wrappers (for example Android `run_mix` scripts in the [example app](https://github.com/elixir-desktop/desktop-example-app)) should not hard-code asdf-specific paths. Prefer invoking Mix through your activated environment, or explicitly via `mise exec -- mix …` / `asdf exec mix …` when you rely on a version manager.
144+
145+
After your toolchain is active, you can verify it against the project’s `.tool-versions` from this library:
146+
147+
```bash
148+
mix desktop.check_toolchain
128149
```
129150

130151
**Install NIF Dependencies:**

0 commit comments

Comments
 (0)