From eedf08031d2a7bd9c4ec81b0088c91a7154328f8 Mon Sep 17 00:00:00 2001 From: Slack Coder Date: Sun, 8 Jan 2023 08:22:33 -0500 Subject: [PATCH] README: Add install instructions Advise on how to install the project as `cargo install` requires the `--locked` option to succeed. Signed-off-by: Slack Coder --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 637ce454..dd7f9f5b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,18 @@ # ❤️🪵 *Radicle Heartwood Protocol & Stack* + +Heartwood is in the early development phase and is not yet ready for use. + +## Installation + +``` +# Command line tools +$ cargo install --locked --path ./radicle-cli + +# The radicle node +$ cargo install --locked --path ./radicle-node + +# Git tool to support the 'rad://' remote scheme +$ cargo install --locked --path ./radicle-remote-helper +```