docs/pages/getting-started/1-installation.mdx

75 lines
2.1 KiB
Text
Raw Normal View History

2023-07-28 17:59:09 +01:00
import { Callout } from 'nextra/components'
2023-07-22 13:25:44 +01:00
# Installation
The preferred way of installing Lune is using [Aftman](https://github.com/lpghatguy/aftman).
Install Aftman, and run this command in your terminal to add `lune` to an `aftman.toml` file in the
current directory, or create one if it does not exist:
2023-07-22 13:25:44 +01:00
```sh copy filename="Bash"
2023-07-22 13:25:44 +01:00
aftman add filiptibell/lune
```
## Other Installation Options
<details>
<summary>Using GitHub Releases</summary>
You can download pre-built binaries for most systems directly from the
[GitHub Releases](https://github.com/filiptibell/lune/releases) page. <br /> There are many tools
that can install binaries directly from releases, and it is up to you to choose what tool to use
when installing here.
</details>
<details>
<summary>Community-maintained</summary>
2023-07-28 17:59:09 +01:00
### AUR (Arch User Repository)
There are a number of packages available on the AUR:
- `lune` - Builds from the latest stable release source.
- `lune-git` - Builds from the latest commit in the repo; unstable.
- `lune-bin` - Installs a precompiled binary from GitHub Release artifacts.
These can be installed with your favourite AUR manager as such:
```sh copy filename="Bash"
2023-07-28 17:59:09 +01:00
paru -S [PACKAGE_NAME]
```
***or***
```sh copy filename="Bash"
2023-07-28 17:59:09 +01:00
yay -S [PACKAGE_NAME]
```
2023-07-28 17:59:09 +01:00
<Callout type="warning" emoji="⚠️">
Only one of these AUR packages must be installed at a time in order to prevent conflicts.
</Callout>
</details>
2023-07-22 13:25:44 +01:00
<details>
<summary>Building from source</summary>
2023-07-22 13:25:44 +01:00
Building and installing from source requires the latest version of
[Rust & Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) to be installed on
your system. <br /> Once installed, run the following command in your terminal:
```sh copy filename="Bash"
2023-07-22 13:25:44 +01:00
cargo install lune --locked
```
</details>
2023-07-22 13:25:44 +01:00
## Next Steps
2023-07-22 13:25:44 +01:00
Congratulations! You've installed Lune and are now ready to write your first script.
- If you want to write standalone scripts, head over to the
[Introduction](./2-introduction/1-hello-lune.md) section.
2023-07-22 13:25:44 +01:00
- If you want to write Lune scripts specifically for Roblox, check out the
[Roblox](../roblox/1-introduction.md) section.