From 48f15527a2c903196d0f1b2f9102c9730761505e Mon Sep 17 00:00:00 2001 From: Filip Tibell Date: Sat, 27 Jul 2024 12:38:45 +0200 Subject: [PATCH] Migrate installation instructions to use Rokit --- pages/getting-started/1-installation.mdx | 37 ++++++++++++++++++++---- 1 file changed, 31 insertions(+), 6 deletions(-) diff --git a/pages/getting-started/1-installation.mdx b/pages/getting-started/1-installation.mdx index e4442a2..95f600b 100644 --- a/pages/getting-started/1-installation.mdx +++ b/pages/getting-started/1-installation.mdx @@ -1,16 +1,40 @@ -import { Callout } from 'nextra/components' +import { Callout, Steps } from 'nextra/components' # Installation -The preferred way of installing Lune is using [Aftman](https://github.com/lpghatguy/aftman). +The preferred way of installing Lune is using [Rokit](https://github.com/rojo-rbx/rojo), +a toolchain manager for Roblox projects. Rokit can manage your installed version of Lune and +other ecosystem tools, and allows you to easily upgrade to newer versions as they become available. -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: + + +### Installing Rokit + +Follow the installation instructions on the [Rokit](https://github.com/rojo-rbx/rojo) page. + +### Installing Lune + +Navigate to your project directory using your terminal, and run the following command: ```sh copy filename="Bash" -aftman add lune-org/lune +rokit add lune ``` +### Upgrading Lune + +When a new version of Lune becomes available, using Rokit will also allow you to easily upgrade to it. +Navigate to your project directory using your terminal again, and run the following command: + +```sh copy filename="Bash" +rokit update lune +``` + + + +If you prefer to install Lune globally and having it be accessible on your entire system, +instead of only in a specific project, you can do this with Rokit as well. Just add the +`--global` option to the end of the commands above. + ## Other Installation Options
@@ -19,7 +43,8 @@ aftman add lune-org/lune You can download pre-built binaries for most systems directly from the [GitHub Releases](https://github.com/lune-org/lune/releases) page.
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. +when installing here. Lune is compatible with both [Foreman](https://github.com/Roblox/foreman) +and [Aftman](https://github.com/LPGhatguy/aftman).