-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d15f239
commit f3daebf
Showing
2 changed files
with
27 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Installation | ||
|
||
## Quick Installation (Unix only) | ||
|
||
Enter the command below to quickly install Allay. | ||
|
||
```console | ||
curl https://allay-mc.github.io/getallay/getallay.sh -sSf | sh | ||
``` | ||
|
||
## Manual Installation | ||
|
||
Visit the [release page](https://github.com/allay-mc/allay/releases/) and | ||
select the archive that matches your platform. Extract it and put the | ||
executable to some path of your choise (usually something like `/usr/local/bin` | ||
on Unix and `C:\Program Files` on Windows). | ||
|
||
If your platform is not supported or you just prefer to build Allay yourself, | ||
then you can do so by following the instructions below. | ||
|
||
1. Make sure you have [Rust and Cargo][Rust] installed. | ||
2. Install with `cargo install --git https://github.com/allay-mc/allay.git` or | ||
clone the repository with `git clone https://github.com/allay-mc/allay.git` | ||
and then run `cargo install --path allay`. | ||
|
||
[Rust]: https://www.rust-lang.org/ |