diff options
author | Quentin Dufour <quentin@deuxfleurs.fr> | 2022-08-01 10:35:29 +0200 |
---|---|---|
committer | Quentin Dufour <quentin@deuxfleurs.fr> | 2022-08-01 10:35:29 +0200 |
commit | 112e63b5d7feb9476b6bd1852dc276bb3de2d0bd (patch) | |
tree | 4cae7617506bbd3fe387ebd63b26b3e63bf14f11 /doc/src/installation.md | |
parent | 441730e1f7a27541d52d1aaccc59a8204a96d079 (diff) | |
download | aerogramme-112e63b5d7feb9476b6bd1852dc276bb3de2d0bd.tar.gz aerogramme-112e63b5d7feb9476b6bd1852dc276bb3de2d0bd.zip |
First iteration on documentation
Diffstat (limited to 'doc/src/installation.md')
-rw-r--r-- | doc/src/installation.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/src/installation.md b/doc/src/installation.md new file mode 100644 index 0000000..1b5d485 --- /dev/null +++ b/doc/src/installation.md @@ -0,0 +1,25 @@ +# Installation + +Install a Rust nightly toolchain: [go to Rustup](https://rustup.rs/). + +Install and deploy a Garage cluster: [go to Garage documentation](https://garagehq.deuxfleurs.fr/documentation/quick-start/). + +Clone Aerogramme's repository: + +```bash +git clone https://git.deuxfleurs.fr/Deuxfleurs/aerogramme/ +``` + +Compile Aerogramme: + +```bash +cargo build +``` + +Check that your compiled binary works: + +```bash +cargo run +``` + +You are now ready to [setup Aerogramme!](./setup.md) |