README: document dependencies better
diff mbox

Message ID 20161123052816.16015-1-andrew.donnellan@au1.ibm.com
State Accepted
Delegated to: Russell Currey
Headers show

Commit Message

Andrew Donnellan Nov. 23, 2016, 5:28 a.m. UTC
Add a section documenting non-Rust dependencies we have. This is probably
incomplete, but it's a start. Also note that cargo will get all our Rust
dependencies for us.

Reported-by: Russell Currey <ruscur@russell.cc>
Closes: #37 ("Document non-Rust dependencies")
Signed-off-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com>
---
 README.md | 18 +++++++++++++-----
 1 file changed, 13 insertions(+), 5 deletions(-)

Comments

Andrew Donnellan Nov. 29, 2016, 2:08 a.m. UTC | #1
On 23/11/16 16:28, Andrew Donnellan wrote:
> Add a section documenting non-Rust dependencies we have. This is probably
> incomplete, but it's a start. Also note that cargo will get all our Rust
> dependencies for us.
>
> Reported-by: Russell Currey <ruscur@russell.cc>
> Closes: #37 ("Document non-Rust dependencies")
> Signed-off-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com>

With minor whitespace fix:

Applied to master: c5c43cff4f102ad820a1871534b864becd1e15f9

Patch
diff mbox

diff --git a/README.md b/README.md
index 0b0c1c1..86057ff 100644
--- a/README.md
+++ b/README.md
@@ -30,12 +30,20 @@  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.
 We do not provide pre-built binaries at this stage.
 
-snowpatch also requires the `git` binary to be installed.  We try to use the 
-[git2-rs](https://github.com/alexcrichton/git2-rs) library where possible,
-however some operations require the binary (such as applying patches).
+### Non-Rust dependencies
 
-snowpatch can be compiled with `cargo build --release`, which will make
-`target/release/snowpatch`.
+* [`git`](https://git-scm.com): we try to use the
+  [`git2-rs`](https://github.com/alexcrichton/git2-rs) library where
+  possible, but we still need the binary for a few operations.
+* [CMake](https://cmake.org)
+* [OpenSSL](https://www.openssl.org) headers
+* [OpenSSH](https://www.openssh.com) headers 
+
+### Building
+
+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`.
 
 
 Contributing