Merge pull request #135 from fireice-uk/topic-doc-ext

Update docs
This commit is contained in:
fireice-uk
2017-11-18 21:57:37 +00:00
committed by GitHub
2 changed files with 27 additions and 0 deletions
+3
View File
@@ -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
+24
View File
@@ -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-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-portbin-linux.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-portbin-linux.tar.gz' | sed 's/.*"//'`
curl -O http://path.to/your/config.txt
tar xzf xmr-stak-portbin-linux.tar.gz
./xmr-stak.sh
```
XMR-Stak will auto-configure and go to work. You don't even need Docker!