@@ -42,9 +42,9 @@ creation of snowpatch.
Installing
----------
-snowpatch is a [Rust](https://www.rust-lang.org) program. In order to compile
-it, you will need Rust and its package manager, Cargo. snowpatch should run
-on any target that Rust compiles on, however it has only been tested on Linux.
+snowpatch is a [Rust](https://www.rust-lang.org) program. In order to compile
+it, you will need Rust and its package manager, Cargo. snowpatch should run on
+any target that supports Rust and Git, however it has only been tested on Linux.
We do not provide pre-built binaries at this stage.
### Non-Rust dependencies
@@ -56,11 +56,17 @@ We do not provide pre-built binaries at this stage.
* [OpenSSL](https://www.openssl.org) headers
* [OpenSSH](https://www.openssh.com) headers
-### Building
+### Installing with cargo
-snowpatch can be compiled with `cargo build --release`, which will
-download and build the Rust packages we depend on. The executable can
-be found in `target/release/snowpatch`.
+To install the latest tagged release of snowpatch using cargo, run `cargo
+install snowpatch`, which will download and compile snowpatch and all its Rust
+dependencies. The snowpatch binary will be installed as `snowpatch`.
+
+### Building manually
+
+To compile snowpatch manually, clone the git repository and run `cargo build
+--release`. The executable can be found in `target/release/snowpatch` or
+executed using `cargo run`.
Contributing
Update the installation instructions in preparation for pushing a release to crates.io, which I intend to do very soon. Also clarify that snowpatch will only run on platforms that support both Rust and Git, because I'm not sure snowpatch will run bare-metal on a microcontroller. Signed-off-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com> --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-)