Skip to content

Commit

Permalink
Added Windows section in contribution guide to help build.
Browse files Browse the repository at this point in the history
  • Loading branch information
bicarlsen committed Oct 21, 2024
1 parent 2469039 commit 584e655
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 }
```

0 comments on commit 584e655

Please sign in to comment.