Skip to content

Commit 628f046

Browse files
author
Marc Jakobi
committed
docs: update install guide
1 parent 056dfb0 commit 628f046

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

docs/tutorial/02-getting-started.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,49 @@ sidebar_label: Getting Started
77
import Tabs from '@theme/Tabs';
88
import TabItem from '@theme/TabItem';
99

10+
## Packages
11+
12+
Lux includes the following packages and libraries:
13+
14+
- `lux-cli`: The main CLI for interacting with projects and installing Lua packages
15+
from the command line.
16+
17+
- `lux-lua`: The Lux Lua API, which provides:
18+
- `lux.loader` for resolving potentially conflicting dependencies on `require` at runtime.
19+
- A work-in-progress API for embedding Lux into Lua applications.
20+
We provide builds of `lux-lua` for Lua 5.1, 5.2, 5.3, 5.4 and Luajit.
21+
22+
- `lux-lib`: The Lux library for Rust. A dependency of `lux-cli` and `lux-lua`.
23+
24+
## Installing Lux With a Distribution's Package Manager
25+
26+
### Arch User Repo (Arch Linux)
27+
28+
[![AUR package](https://repology.org/badge/version-for-repo/aur/lux-cli.svg)](https://aur.archlinux.org/packages/lux-cli)
29+
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.
34+
35+
### Nix and NixOS
36+
37+
[![nixpkgs unstable package](https://repology.org/badge/version-for-repo/nix_unstable/lux-cli.svg)](https://search.nixos.org/packages?channel=unstable&show=lux-cli&from=0&size=50&sort=relevance&type=packages&query=lux-cli)
38+
39+
If you are using [Nix or NixOS](https://nixos.org/),
40+
you can install [`lux-cli`](https://search.nixos.org/packages?channel=unstable&show=lux-cli&from=0&size=50&sort=relevance&type=packages&query=lux-cli)
41+
and [`lux-lua` for various Lua versions](https://search.nixos.org/packages?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=lux-lua).
42+
You may also need to configure [`pkg-config`](https://search.nixos.org/packages?channel=unstable&show=pkg-config&from=0&size=50&sort=relevance&type=packages&query=pkg-config)
43+
so that it can find `lux-lua` and Lua.
44+
45+
If you would like to use the latest release, our [source repository](https://github.com/nvim-neorocks/lux)
46+
also provides a Nix flake.
47+
48+
## Installing The Latest Release Using Cargo
49+
1050
Due to the fact that we have no stable release yet, you must install the project
11-
through `cargo`. We recommend installing through `cargo binstall` for fastest install times:
51+
through `cargo` if you want the latest release and are not using the Nix flake.
52+
We recommend installing through `cargo binstall` for fastest install times:
1253

1354
```sh
1455
cargo binstall lux-cli --locked

0 commit comments

Comments
 (0)