aboutsummaryrefslogtreecommitdiff
path: root/doc/src/installation.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/installation.md')
-rw-r--r--doc/src/installation.md25
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)