aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSteven Fackler <[email protected]>2015-02-07 21:39:51 -0800
committerSteven Fackler <[email protected]>2015-02-07 21:39:51 -0800
commit6f10585593a786955f940b8f50647d44220156e8 (patch)
tree820d5e562fc6e0a75bf466ef342cad4c80d2b6bb /README.md
parentMove docs to this repo and auto build (diff)
downloadrust-openssl-6f10585593a786955f940b8f50647d44220156e8.tar.xz
rust-openssl-6f10585593a786955f940b8f50647d44220156e8.zip
Build fixes
Diffstat (limited to 'README.md')
-rw-r--r--README.md44
1 files changed, 31 insertions, 13 deletions
diff --git a/README.md b/README.md
index cecf2c9d..f97332e7 100644
--- a/README.md
+++ b/README.md
@@ -6,8 +6,10 @@ See the [rustdoc output](https://sfackler.github.io/rust-openssl/doc/openssl).
Building
--------
-rust-openssl needs to link against the OpenSSL devleopment libraries on your system. It's very easy to get them on Linux.
-For some reason, the OpenSSL distribution for Windows is structured differently, so it's a little more involved, but it *is* possible to build rust-openssl successfully on Windows.
+rust-openssl needs to link against the OpenSSL devleopment libraries on your
+system. It's very easy to get them on Linux. For some reason, the OpenSSL
+distribution for Windows is structured differently, so it's a little more
+involved, but it *is* possible to build rust-openssl successfully on Windows.
###Linux
@@ -15,26 +17,42 @@ For some reason, the OpenSSL distribution for Windows is structured differently,
2. Run `cargo build`.
###Android
-1. Follow the steps [here](wiki.openssl.org/index.php/Android) to build OpenSSL for android
+1. Follow the steps [here](wiki.openssl.org/index.php/Android) to build OpenSSL
+ for android
2. Provide the path to the libssl and libcrypto binaries via `$OPENSSL_PATH`
3. Build the package with `cargo build`
###Windows
-1. Grab the latest Win32 OpenSSL installer [here][1]. At the time of this writing, it's v1.0.1i. If you're using 64-bit Rust (coming to Windows soon), then you should get the Win64 installer instead.
-2. Run the installer, making note of where it's installing OpenSSL. The option to copy the libraries to the Windows system directory or `[OpenSSL folder]/bin` is your choice. The latter is probably preferable, and the default.
-3. Navigate to `[OpenSSL folder]/lib/MinGW/`, and copy `libeay32.a` and `ssleay32.a` (If 64-bit, then they will have `64` instead of `32`.) to your Rust install's libs folder. The default should be:
+1. Grab the latest Win32 OpenSSL installer [here][1]. At the time of this
+ writing, it's v1.0.1i. If you're using 64-bit Rust (coming to Windows soon),
+then you should get the Win64 installer instead.
+2. Run the installer, making note of where it's installing OpenSSL. The option
+ to copy the libraries to the Windows system directory or `[OpenSSL
+folder]/bin` is your choice. The latter is probably preferable, and the
+default.
+3. Navigate to `[OpenSSL folder]/lib/MinGW/`, and copy `libeay32.a` and
+`ssleay32.a` (If 64-bit, then they will have `64` instead of `32`.) to your
+Rust install's libs folder. The default should be:
* 32-bit: `C:\Program Files (x86)\Rust\bin\rustlib\i686-pc-mingw32\lib`
* 64-bit: `C:\Program Files (x86)\Rust\bin\rustlib\x86_64-pc-windows-gnu\lib`
-4. Rename `libeay32.a` and `ssleay32.a` to `libcrypto.a` and `libssl.a`, respectively.
+4. Rename `libeay32.a` and `ssleay32.a` to `libcrypto.a` and `libssl.a`,
+respectively.
5. Run `cargo build`.
###Testing
-Several tests expect a local test server to be running to bounce requests off of. It's easy to do this. Open a separate terminal window and `cd` to the rust-openssl directory. Then run one of the following commands:
-
-* Windows: `openssl s_server -accept 15418 -www -cert test/cert.pem -key test/key.pem > NUL`
-* Linux: `openssl s_server -accept 15418 -www -cert test/cert.pem -key test/key.pem >/dev/null`
-
-Then in the original terminal, run `cargo test`. If everything is set up correctly, all tests should pass. You might get some warnings in the `openssl s_server` window. Those aren't anything to worry about. You can stop the server using Control-C.
+Several tests expect a local test server to be running to bounce requests off
+of. It's easy to do this. Open a separate terminal window and `cd` to the
+rust-openssl directory. Then run one of the following commands:
+
+* Windows: `openssl s_server -accept 15418 -www -cert test/cert.pem -key
+ test/key.pem > NUL`
+* Linux: `openssl s_server -accept 15418 -www -cert test/cert.pem -key
+ test/key.pem >/dev/null`
+
+Then in the original terminal, run `cargo test`. If everything is set up
+correctly, all tests should pass. You might get some warnings in the `openssl
+s_server` window. Those aren't anything to worry about. You can stop the server
+using Control-C.
[1]: http://slproweb.com/products/Win32OpenSSL.html