From 584e65595bacf955a4c3eb2bee0219948311f665 Mon Sep 17 00:00:00 2001 From: Brian Carlsen Date: Mon, 21 Oct 2024 08:47:58 -0600 Subject: [PATCH] Added Windows section in contribution guide to help build. --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 84c4c9be..3b4cc193 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,3 +27,16 @@ We follow [semver](https://semver.org/spec/v2.0.0.html) for versioning this syst - all release tags should start with the letter `v` followed by a semver version. - [ ] CI is configured for release tags and will create a new GitHub release, and will upload release artifacts to the release page. Verify that this process has completed successfully. +## Windows +If you receive an error about OpenSSL not being installed, the easiest way to get around this is to build using `rustls` instead of `natvie-tls`. +```sh +cargo build --no-default-features -F update_check,rustls +``` +If you want to use `native-tls` you can install OpenSSL using the instructions from one of the following resources: ++ https://stackoverflow.com/a/62729715/2961550 ++ https://github.com/sfackler/rust-openssl/issues/1062#issuecomment-489441940 +Or try using [rust-openssl from PR #2139](https://github.com/sfackler/rust-openssl/pull/2139) by updating the `Cargo.toml` file with +```diff +- openssl = { version = "0.10", default-features = false, optional = true } ++ openssl = { git = "https://github.com/micolous/rust-openssl", branch = "windows-build", default-features = false, optional = true } +``` \ No newline at end of file