Skip to content

Commit

Permalink
Make install instructions even clearer and fix some formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
filiptibell committed Jul 17, 2024
1 parent e4f3533 commit 5a9f129
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,17 @@ Follow the instructions for your platform below - when installed, Rokit will gui

### macOS & Linux

- Run the automated installer script in your terminal:
Run the automated installer script in your terminal:

```sh
curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/rojo-rbx/rokit/main/scripts/install.sh | sh
```
```sh
curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/rojo-rbx/rokit/main/scripts/install.sh | sh
```

### Windows

- Download and run `rokit.exe` from the [latest release][latest-release] page - this will automatically install Rokit.
Download and run<sup>\*</sup> `rokit.exe` from the [latest release][latest-release] page - this will automatically install Rokit.

<sup>\* Make sure to run `rokit.exe` **directly**, not from a shell such as PowerShell or CMD, for automatic installation to work.</sup>

### Other

Expand All @@ -37,7 +39,8 @@ Follow the instructions for your platform below - when installed, Rokit will gui
Rokit can be compiled and installed from source using [`cargo`][rustup]:

```sh
cargo install rokit --locked
cargo install rokit --locked # Installs the Rokit binary
rokit self-install # Initializes necessary directories and data files for Rokit to work
```

This _may_ work on systems that Rokit is not officially compatible with, but note that no support is provided for non-official targets. <br/>
Expand Down

0 comments on commit 5a9f129

Please sign in to comment.