update documentation

- add CMake flag description - announce Monero and Aeon in README.md i add FAQ section
Spudz76 · Oct 27, 2017 · 77666c7 · 77666c7
1 parent b0bb957
commit 77666c7
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# XMR-Stak - Monero All-in-One Mining Software
+# 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.
+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.
 
 ## HTML reports
 <img src="https://gist.githubusercontent.com/fireice-uk/2da301131ac01695ff79539a27b81d68/raw/4c09cdeee86f94df2e9dd86b927e64aded6184f5/xmr-stak-cpu-hashrate.png" width="260"> <img src="https://gist.githubusercontent.com/fireice-uk/2da301131ac01695ff79539a27b81d68/raw/4c09cdeee86f94df2e9dd86b927e64aded6184f5/xmr-stak-cpu-results.png" width="260"> <img src="https://gist.githubusercontent.com/fireice-uk/2da301131ac01695ff79539a27b81d68/raw/4c09cdeee86f94df2e9dd86b927e64aded6184f5/xmr-stak-cpu-connection.png" width="260">
@@ -18,6 +18,7 @@ XMR-Stak is a universal Stratum pool miner. This miner supports CPUs, AMD and NV
 
 - support all common backends (CPU/x86, AMD-GPU and NVIDIA-GPU)
 - support all common OS (Linux, Windows and MacOS)
+- supports algorithm cryptonight for Monero (XMR) and cryptonight-light (AEON)
 - easy to use
   - guided start (no need to edit a config file for the first start)
   - auto configuration for each backend

diff --git a/doc/FAQ.md b/doc/FAQ.md
@@ -7,6 +7,7 @@
 * [Error: MEMORY ALLOC FAILED: mmap failed](#error-memory-alloc-failed-mmap-failed)
 * [Illegal instruction (core dumped)](#illegal-instruction)
 * [Virus Protection Alert](#virus-protection-alert)
+* [Change Currency to Mine](#change-currency-to-mine)
 
 ## SeLockMemoryPrivilege failed
 
@@ -59,3 +60,9 @@ Some Virus protection software flag the miner binary as *Male Ware*.
 In this case the binary is moved to the quarantine area of the protection software.
 This is a wrong alert and not avoid by use.
 Add the binary to to protection software white list to solve this issue.s
+
+## Change Currency to Mine
+
+If the miner is compiled for Monero and Aeon than you can change
+ - the value `currency` in the config *or*
+ - start the miner with the [command line option](usage.md) `--currency xmr` or `--currency aeon`
diff --git a/doc/compile.md b/doc/compile.md
@@ -47,6 +47,7 @@ After the configuration you need to compile the miner, follow the guide for your
 - `WIN_UAC` will enable or disable the "Run As Administrator" prompt on Windows.
   - UAC confirmation is needed to use large pages on Windows 7.
   - On Windows 10 it is only needed once to set up the account to use them.
+- `XMR-STAK_CURRENCY` - compile for Monero(xmr) or Aeon(aeon) usage only e.g. `cmake .. -DXMR-STAK_CURRENCY=xmr`
 
 ## CPU Build Options
 

diff --git a/doc/usage.md b/doc/usage.md
@@ -31,8 +31,9 @@ The miner allow to overwrite some of the settings via command line options.
 ```
 Usage: xmr-stak [OPTION]...
 
-  -c, --config FILE     common miner configuration file
   -h, --help            show this help
+  -c, --config FILE     common miner configuration file
+  --currency NAME       currency to mine: xmr or aeon
   --noCPU               disable the CPU miner backend
   --cpu FILE            CPU backend miner config file
   --noAMD               disable the AMD miner backend