Merge branch 'master' of github.com:rilut/rust-tldr

README.md

@@ -0,0 +1,51 @@
+# rust-tldr
+
+A client for [*tldr*](http://tldr-pages.github.io/), written in Rust.
+
+*tldr* is a simplified and community-driven man pages.
+
+## Preinstallation
+
+### Linux
+
+Nothing! You should be good to go!
+
+### Windows
+
+*Refer to the [Windows section of rust-openssl readme](https://github.com/sfackler/rust-openssl#windows)*
+
+tldr: Install OpenSSL from [here](http://slproweb.com/products/Win32OpenSSL.html). Pick 32/64-bit depending on your system. But Cargo will not be able to find OpenSSL. You can either copy the `include/openssl` directory, libssl32.dll, and libeay32.dll to locations that Cargo can find or pass the location to Cargo via environment variables:
+
+    env OPENSSL_LIB_DIR=C:/OpenSSL-Win64 OPENSSL_INCLUDE_DIR=C:/OpenSSL-Win64/include
+    cargo build
+
+**Or alternatively, download my 64-bit `tldr.exe` instead from https://github.com/rilut/rust-tldr/releases, and include it to your PATH.**
+
+### OSX
+
+*Refer to the [OSX section of rust-openssl readme](https://github.com/sfackler/rust-openssl#osx)*
+
+tldr: If you are running El Capitan, you will encounter a problem from the missing openssl header when installing the client. To fix that, you should try all of this:
+
+```shell
+# first, try:
+brew link --force openssl
+
+# if it didn't work, try:
+export OPENSSL_INCLUDE_DIR=/usr/local/Cellar/openssl/1.0.2d_1/include/
+
+# if it still didn't work, try:
+export C_INCLUDE_PATH=/usr/local/Cellar/openssl/1.0.2d_1/include/
+```
+
+Read all of the possible fixes for the El Capitan problems at: https://github.com/sfackler/rust-openssl/issues/255
+
+## Installation
+
+```sh
+$ cargo install tldr
+```
+
+## License 
+
+MIT