From 41f5cfd7b92bb533f38420bc93b4e893166f8b9b Mon Sep 17 00:00:00 2001 From: Nicholas Pettas Date: Mon, 3 Jun 2024 18:37:17 -0700 Subject: [PATCH 1/2] Update README.md to include run from binaries --- README.md | 43 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d2e5899..f99f8e3 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,48 @@ ## Installation -### Clone the repo +### From Binaries + +Download the package for your OS. Extract and run. +https://github.com/FairCrypto/sol-xen/releases/latest + +> MacOS +```shell +# Download +wget https://github.com/faircrypto/sol-xen/releases/latest/download/sol-xen-macos-universal.tar.gz + +# Extract +tar xf sol-xen-macos-universal.tar.gz + +# Run the miner +./sol-xen-macos-universal/sol-xen-multiminer --help +``` + +> Linux (x86_64) +``` +# Download +wget https://github.com/faircrypto/sol-xen/releases/latest/download/sol-xen-linux-x86_64.tar.gz + +# Extract +tar xf sol-xen-linux-x86_64.tar.gz + +# Run the miner +./sol-xen-linux-x86_64/sol-xen-multiminer --help +``` + +> Linux (arm64) +```shell +# Download +wget https://github.com/faircrypto/sol-xen/releases/latest/download/sol-xen-linux-arm64.tar.gz + +# Extract +tar xf sol-xen-linux-arm64.tar.gz + +# Run the miner +./sol-xen-linux-arm64/sol-xen-multiminer --help +``` + +### From Source ``` git clone https://github.com/FairCrypto/sol-xen.git From 2a8dccbae7be39fb1f0ea5dcee214f377fbcaf33 Mon Sep 17 00:00:00 2001 From: Nicholas Pettas Date: Mon, 3 Jun 2024 18:37:48 -0700 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f99f8e3..2ea9d6d 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ tar xf sol-xen-macos-universal.tar.gz ``` > Linux (x86_64) -``` +```shell # Download wget https://github.com/faircrypto/sol-xen/releases/latest/download/sol-xen-linux-x86_64.tar.gz