summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlex Crichton <alex@alexcrichton.com>2015-12-12 09:30:09 -0800
committerAlex Crichton <alex@alexcrichton.com>2015-12-12 09:30:09 -0800
commit695edf7c9f5378d56797b23a24966624f9387eb1 (patch)
treebef3b97a87983915837cb8911e207b2a10250862 /README.md
parentb03987cecef7214915d9ca5cf078781511533202 (diff)
downloadssh2-rs-695edf7c9f5378d56797b23a24966624f9387eb1.zip
Add a note about OSX 10.10
Closes #28
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index b67cca6..b77c131 100644
--- a/README.md
+++ b/README.md
@@ -12,3 +12,24 @@ Rust bindings to libssh2
[dependencies]
ssh2 = "0.2"
```
+
+## Building on OSX 10.10+
+
+Currently libssh2 requires linking against OpenSSL, and to compile libssh2 it
+also needs to find the OpenSSL headers. On OSX 10.10+ the OpenSSL headers have
+been removed, but if you're using Homebrew you can install them via:
+
+```
+brew install openssl
+```
+
+To get this library to pick them up the [standard `rust-openssl`
+instructions][instr] can be used to transitively inform libssh2-sys about where
+the header files are:
+
+[instr]: https://github.com/sfackler/rust-openssl#osx
+
+```
+export OPENSSL_INCLUDE_DIR=`brew --prefix openssl`/include
+export OPENSSL_LIB_DIR=`brew --prefix openssl`/lib
+```