Merge pull request #99 from anderejd/vendored_openssl

Expose the cargo crate feature: vendored-openssl.
geiger-rs · Apr 17, 2020 · c84a5f1 · c84a5f1
2 parents 83e1eb3 + 747243c
commit c84a5f1
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 5 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/README.md b/README.md
@@ -11,13 +11,24 @@ This cargo plugin is based on the code from two other projects:
 <https://github.com/icefoxen/cargo-osha> and
 <https://github.com/sfackler/cargo-tree>.
 
+Installation
+------------
+
+Try to find and use a system-wide installed OpenSSL library:
+```
+cargo install cargo-geiger
+```
+
+Or, build and statically link OpenSSL as part of the cargo-geiger executable:
+```
+cargo install cargo-geiger --features vendored-openssl
+```
 
 Usage
 -----
 
-1. `cargo install cargo-geiger`
-2. Navigate to the same directory as the `Cargo.toml` you want to analyze.
-3. `cargo geiger`
+1. Navigate to the same directory as the `Cargo.toml` you want to analyze.
+2. `cargo geiger`
 
 
 Output example

diff --git a/cargo-geiger/Cargo.toml b/cargo-geiger/Cargo.toml
@@ -24,6 +24,9 @@ petgraph = "0.5.0"
 pico-args = "0.3.1"
 walkdir = "2.3.1"
 
+[features]
+vendored-openssl = ["cargo/vendored-openssl"]
+
 [dev-dependencies]
 assert_cmd = "1.0.1"
 better-panic = "0.2.0"