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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

[README] Add Linux/macOS/Windows specific instructions #118

Merged

Conversation

corrieriluca
Copy link
Contributor

@corrieriluca corrieriluca commented Nov 10, 2021

Hi,

This PR adds a subsection "Dependencies" under the "Install" section in the README to give more details on how to install the dependencies needed to compile Drill.

Most notably the Windows specific instructions on how to install OpenSSL were missing. It is through the error messages of the openssl-sys crate's custom build script that I found that Vcpkg was needed along with the package openssl:x64-windows-static-md.

Regards 馃槃

@4F2E4A2E
Copy link

On Windows, this is what I did to get it running:

  • Run git clone https://github.com/Microsoft/vcpkg.git into, e.g.: C:\work\tools\vcpkg
  • Run .\vcpkg\bootstrap-vcpkg.bat in your PowerShell
  • Run .\vcpkg.exe integrate install
  • Download and install the MSI Win64 OpenSSL v3.0.0 from https://slproweb.com/products/Win32OpenSSL.html
  • Set the env OPENSSL_DIR with the value C:\Program Files\OpenSSL-Win64
  • Add the env %OPENSSL_DIR% to the user path
  • Restart a PowerShell and run cargo install drill
  • Install drill cargo install drill
  • Run drill --benchmark .yml --stats

@corrieriluca
Copy link
Contributor Author

  • Run git clone https://github.com/Microsoft/vcpkg.git into, e.g.: C:\work\tools\vcpkg
  • Run .\vcpkg\bootstrap-vcpkg.bat in your PowerShell
  • Run .\vcpkg.exe integrate install

Hi @4F2E4A2E, these instructions are indeed the one provided on the Vcpkg website, I dropped a link to this website in the README as it will always contain the most up to date instructions to install vcpkg.

It is true that this is also a valid method to install OpenSSL, however it does not require vcpkg to be installed. Because this method (overriding the config of the openssl crate build script) is referred as Manual in the documentation of openssl. Using vcpkg refers to the Automatic method, the build script uses vcpkg to infer where to find the OpenSSL library on the system.

I did not talk about this method in the README because I wanted to show highlight a method that can be done only from a command line, which is not the method you're describing, with the MSI installer of OpenSSL.

Anyway, thanks for the comment, it will surely help, as it is an alternative method to install OpenSSL on Windows 馃槃

@fcsonline
Copy link
Owner

Thank you so much for your contribution! Merging!

@fcsonline fcsonline merged commit e7b7469 into fcsonline:master Dec 2, 2021
@corrieriluca corrieriluca deleted the readme-platform-instructions branch December 3, 2021 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants