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 <slackcoder@server.ky>
This commit is contained in:
Slack Coder 2023-01-08 08:22:33 -05:00 committed by Alexis Sellier
parent dec7979644
commit eedf08031d
No known key found for this signature in database
1 changed files with 15 additions and 0 deletions

View File

@ -1,3 +1,18 @@
# ❤️🪵 # ❤️🪵
*Radicle Heartwood Protocol & Stack* *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
```