From 53cccb7d3f85980d8864dbabcf0fde3880000ae7 Mon Sep 17 00:00:00 2001 From: Hardhat Chad Date: Thu, 8 Aug 2024 13:36:49 +0000 Subject: [PATCH] install instructions --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 73c28b59..ffa06c48 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,30 @@ To install the CLI, use [cargo](https://doc.rust-lang.org/cargo/getting-started/ cargo install ore-cli ``` + +#### Dependencies +If you run into installation issues, please install the dependencies listed below for your operating system and try again: + +Linux +``` +sudo apt-get install openssl pkg-config libssl-dev +``` + +MacOS (using [Homebrew](https://brew.sh/)) +``` +brew install openssl pkg-config + +# If you encounter issues with OpenSSL, you might need to set the following environment variables: +export PATH="/usr/local/opt/openssl/bin:$PATH" +export LDFLAGS="-L/usr/local/opt/openssl/lib" +export CPPFLAGS="-I/usr/local/opt/openssl/include" +``` + +Windows (using [Chocolatey](https://chocolatey.org/)) +``` +choco install pkgconfiglite +``` + ## Build To build the codebase from scratch, checkout the repo and use cargo to build: