summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorc0gent <nsan1129@gmail.com>2018-08-03 18:20:35 -0700
committerc0gent <nsan1129@gmail.com>2018-08-03 18:20:35 -0700
commit798caf68cb57fb39b70b68ae4ccc7db1dadfafe7 (patch)
treef19ee0b64fae96f699a543baee5d7e5358ec9240 /README.md
parent0d0ed4fc49a4c3984fbe162417b658ac2e85dc1a (diff)
downloadssh2-rs-798caf68cb57fb39b70b68ae4ccc7db1dadfafe7.zip
Add zlib installation note.
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index f234153..9a6b0ca 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,12 @@
Rust bindings to libssh2
+## Usage
+
+Ensure that [`zlib`](https://zlib.net/) is installed (Debian: `sudo apt-get
+install zlib1g-dev`, OSX: `brew install zlib-devel`,
+[Windows](http://gnuwin32.sourceforge.net/packages/zlib.htm))
+
```toml
# Cargo.toml
[dependencies]