Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Windows section in contribution guide to help build. #890

Merged
merged 1 commit into from
Oct 25, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 }
```