Skip to content

Commit 4a7909f

Browse files
author
Marc Jakobi
committed
docs: update install guide
1 parent 7d763a1 commit 4a7909f

File tree

1 file changed

+65
-7
lines changed

1 file changed

+65
-7
lines changed

docs/tutorial/02-getting-started.md

Lines changed: 65 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,68 @@ Lux includes the following packages and libraries:
2121

2222
- `lux-lib`: The Lux library for Rust. A dependency of `lux-cli` and `lux-lua`.
2323

24-
## Installing Lux With a Distribution's Package Manager
24+
## Binary distributions
25+
26+
We provide pre-built binary distributions on our GitHub repository's [releases page](https://github.com/nvim-neorocks/lux/releases/latest).
27+
These come bundled with shell completions, man pages and `lux-lua` for each supported Lua version.
28+
29+
### Linux
30+
31+
#### AppImage
32+
33+
1. Download the AppImage for your architecture:
34+
35+
- `lx_<version>_<arch>.AppImage`
36+
37+
2. Run `chmod u+x lx_<version>_<arch>.AppImage` to make it executable.
38+
39+
If you system does not have FUSE, you can [extract the AppImage](https://github.com/AppImage/AppImageKit/wiki/FUSE#type-2-appimage):
40+
41+
```
42+
./lx_<version>_<arch>.AppImage --appimage-extract
43+
./squashfs-root/usr/bin/lx
44+
```
45+
46+
#### Debian
47+
48+
Download and install the `.deb` package for your architecture:
49+
50+
- `lx_<version>_<arch>.deb`
2551

26-
### Arch User Repo (Arch Linux)
52+
#### Arch Linux
2753

28-
[![AUR package](https://repology.org/badge/version-for-repo/aur/lux-cli.svg)](https://aur.archlinux.org/packages/lux-cli)
54+
Download the `PKGBUILD` and `lx_<version>_86_64.tar.gz` and install using
55+
`makepkg` and `pacman`.
2956

30-
lux-cli [is available in the AUR](https://aur.archlinux.org/packages/lux-cli).
31-
You can install it with your favourite AUR helper.
32-
It comes bundled with the `lux-lua` library, which Lux uses to resolve potentially
33-
conflicting dependencies at runtime.
57+
### macOS
58+
59+
1. Download the `lux-cli_<version>_<arch>.dmg` archive for your architecture.
60+
2. Extract the `.app` bundle to your `Applications`.
61+
3. Make sure the path containing the `lx` binary (`/Applications/lux-cli.app/Contents/MacOS`)
62+
is on your `PATH`.
63+
Or, create a `zsh` alias to the bundled `lx` binary.
64+
65+
:::note
66+
As a young FOSS project, we do not notarize the macOS package,
67+
so you may have to configure Gatekeeper to allow you to use it.
68+
:::
69+
70+
### Windows
71+
72+
1. Download and run the installer:
73+
74+
- `lx_<version>_x64-setup.exe`
75+
- or `lx_<version>_x64_en-US.msi`
76+
77+
As a young FOSS project, we do not sign the Windows package with a CA,
78+
so you will be shown a "Windows protected your PC" warning when running the installer.
79+
:::
80+
81+
2. Add the install directory to your `PATH`.
82+
83+
## Installing Lux With a Distribution's Package Manager
84+
85+
[![Packaging status](https://repology.org/badge/vertical-allrepos/lux-cli.svg)](https://repology.org/project/lux-cli/versions)
3486

3587
### Nix and NixOS
3688

@@ -45,6 +97,12 @@ so that it can find `lux-lua` and Lua.
4597
If you would like to use the latest release, our [source repository](https://github.com/nvim-neorocks/lux)
4698
also provides a Nix flake.
4799

100+
### Arch Linux (Arch User Repository)
101+
102+
For the best experience, we recommend you install the [`lux-cli-bin`](https://github.com/nvim-neorocks/lux/releases/download/v0.15.0/lx_0.15.0_x86_64.tar.gz)
103+
package from the AUR.
104+
It comes bundled with shell completions, man pages and `lux-lua` for each Lua version.
105+
48106
## Installing The Latest Release Using Cargo
49107

50108
Due to the fact that we have no stable release yet, you must install the project

0 commit comments

Comments
 (0)