From f222bd38759eb53376c5c4bedfebe8abcf8c0b30 Mon Sep 17 00:00:00 2001 From: Unknown Date: Sat, 18 Nov 2017 17:16:15 +0000 Subject: [PATCH 1/2] Update docs --- README.md | 3 +++ doc/Linux_deployment.md | 24 ++++++++++++++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 doc/Linux_deployment.md diff --git a/README.md b/README.md index 15f641c..4570b5d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +###### fireice-uk's and psychocrypt's # XMR-Stak - Monero/Aeon All-in-One Mining Software XMR-Stak is a universal Stratum pool miner. This miner supports CPUs, AMD and NVIDIA gpus and can be used to mine the crypto currency Monero and Aeon. @@ -8,6 +9,7 @@ XMR-Stak is a universal Stratum pool miner. This miner supports CPUs, AMD and NV ## Overview * [Features](#features) * [Download](#download) +* [Linux Portable Binary](doc/Linux_deployment.md) * [Usage](doc/usage.md) * [HowTo Compile](doc/compile.md) * [FAQ](doc/FAQ.md) @@ -30,6 +32,7 @@ XMR-Stak is a universal Stratum pool miner. This miner supports CPUs, AMD and NV ## Download You can find the latest releases and precompiled binaries on GitHub under [Releases](https://github.com/xmr-stak/xmr-stak/releases). +If you are running on Linux (especially Linux VMs), checkout [Linux Portable Binary](doc/Linux_deployment.md). ## Default Developer Donation diff --git a/doc/Linux_deployment.md b/doc/Linux_deployment.md new file mode 100644 index 0000000..e464e45 --- /dev/null +++ b/doc/Linux_deployment.md @@ -0,0 +1,24 @@ +# Deploying portable **XMR-Stak** on Linux systems + +XMR-Stak releases include a pre-built portable version. If you are simply using it to avoid having to compile the application, you can simply download **xmr-stak-portable-bin.tar.gz** from our [latest releases](https://github.com/fireice-uk/xmr-stak/releases/latest). Open up command line, and use the following commands: + +``` +tar xzf xmr-stak-portable-bin.tar.gz +./xmr-stak.sh +``` + +Configuration and tuning files will be generated automatically from your answers. + +For automatic deployments, please use the steps above to obtain config.txt and use the following script: + +``` +#!/bin/bash +curl -O `curl -s https://api.github.com/repos/fireice-uk/xmr-stak/releases/latest | grep -o 'browser_download_url.*xmr-stak-portable-bin.tar.gz' | sed 's/.*"//'` +curl -O http://path.to/your/config.txt +tar xzf xmr-stak-portable-bin.tar.gz +./xmr-stak.sh +``` + +XMR-Stak will auto-configure and go to work. You don't even need Docker! + + From fd38122c2f658694010e14ba97a067ca7700a7b2 Mon Sep 17 00:00:00 2001 From: Unknown Date: Sat, 18 Nov 2017 21:44:09 +0000 Subject: [PATCH 2/2] Update docs rename to make it clearer that this is a linux binary --- doc/Linux_deployment.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/Linux_deployment.md b/doc/Linux_deployment.md index e464e45..caf762c 100644 --- a/doc/Linux_deployment.md +++ b/doc/Linux_deployment.md @@ -1,9 +1,9 @@ # Deploying portable **XMR-Stak** on Linux systems -XMR-Stak releases include a pre-built portable version. If you are simply using it to avoid having to compile the application, you can simply download **xmr-stak-portable-bin.tar.gz** from our [latest releases](https://github.com/fireice-uk/xmr-stak/releases/latest). Open up command line, and use the following commands: +XMR-Stak releases include a pre-built portable version. If you are simply using it to avoid having to compile the application, you can simply download **xmr-stak-portbin-linux.tar.gz** from our [latest releases](https://github.com/fireice-uk/xmr-stak/releases/latest). Open up command line, and use the following commands: ``` -tar xzf xmr-stak-portable-bin.tar.gz +tar xzf xmr-stak-portbin-linux.tar.gz ./xmr-stak.sh ``` @@ -13,9 +13,9 @@ For automatic deployments, please use the steps above to obtain config.txt and u ``` #!/bin/bash -curl -O `curl -s https://api.github.com/repos/fireice-uk/xmr-stak/releases/latest | grep -o 'browser_download_url.*xmr-stak-portable-bin.tar.gz' | sed 's/.*"//'` +curl -O `curl -s https://api.github.com/repos/fireice-uk/xmr-stak/releases/latest | grep -o 'browser_download_url.*xmr-stak-portbin-linux.tar.gz' | sed 's/.*"//'` curl -O http://path.to/your/config.txt -tar xzf xmr-stak-portable-bin.tar.gz +tar xzf xmr-stak-portbin-linux.tar.gz ./xmr-stak.sh ```