diff --git a/docs/introduction/installation.md b/docs/introduction/installation.md index b8be2a1..8c5657b 100644 --- a/docs/introduction/installation.md +++ b/docs/introduction/installation.md @@ -1,19 +1,27 @@ # Installation +> **Note:** An installation of the Rust programming language is needed to compile Sabre. + +## Cargo + +The fastest way to get up and running is to install the [latest published version](https://crates.io/crates/sabre-lang) via cargo: + +```sh +cargo install sabre-lang +``` + ## Git -The fastest way to get up and running is to clone the [repository](https://git.sr.ht/~garritfra/sabre) and run the following command: +To get the current development version, you can clone the Git [repository](https://github.com/garritfra/sabre) and run the following command: ```sh cargo install --path . ``` -> **Note:** An installation of the Rust programming language is needed to compile Sabre. - -## Cargo +## Docker -Install the [latest published version](https://crates.io/crates/sabre-lang) via cargo: +Sabre provides a [Docker image](https://hub.docker.com/r/garritfra/sabre). It currently only supports the x64 architecture. Please reach out if you need a ARM variant (needed for Raspberry Pi). If you don't want to wait, you can build the image yourself by running this command in the root of the project: -```sh -cargo install sabre-lang +``` +docker build . -t sabre ```