Skip to content

Commit

Permalink
README: document dependencies better
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
ajdlinux committed Nov 29, 2016
1 parent 3b2e30c commit c5c43cf
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit c5c43cf

Please sign in to comment.