From 6d9ea43e9aad508380295b806347d202ba1c1882 Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 6 Nov 2020 17:56:57 +0100 Subject: [PATCH] Add a development section in readme.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index b8b0287..876653d 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,12 @@ Non-goals include: Our main use case is to provide a distributed storage layer for small-scale self hosted services such as [Deuxfleurs](https://deuxfleurs.fr). +## Development + + 1. Setup a rust/cargo environment + 2. Run `cargo build` to build the project + 3. Run `RUST_BACKTRACE=1 RUST_LOG=garage=debug ./target/debug/garage server -c ./config.dev.toml` to launch a garage test instance (data will be saved in `/tmp`, no encryption, only one instance) + ## Setting up Garage Use the `genkeys.sh` script to generate TLS keys for encrypting communications between Garage nodes.