fzorb/REDACTED-rig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
xmrig 2017-05-13 20:26:35 +03:00 • committed by GitHub
parent 0c2bda9aa5
commit bf25b4e5d4
1 changed files with 15 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -17,10 +17,12 @@ Based on cpuminer-multi with heavy optimizations/rewrites and removing a lot of
## Features ## Features
* High performance (290+ H/s on i7 6700). * High performance (290+ H/s on i7 6700).
* Official Windows support. * Official Windows support.
* Small Windows executable, only 430 KB without dependencies. * Small Windows executable, only 535 KB without dependencies.
* Support for backup (failover) mining server. * Support for backup (failover) mining server.
* keepalived support. * keepalived support.
* Command line options compatible with cpuminer. * Command line options compatible with cpuminer.
* CryptoNight-Lite support for AEON.
* Smart automatic CPU configuration.
* It's open source software. * It's open source software.
## Download ## Download
@ -51,18 +53,18 @@ xmrig.exe -o xmr-eu.dwarfpool.com:8005 -u YOUR_WALLET -p x -k
--donate-level=N donate level, default 5% (5 minutes in 100 minutes) --donate-level=N donate level, default 5% (5 minutes in 100 minutes)
-B, --background run the miner in the background -B, --background run the miner in the background
-c, --config=FILE load a JSON-format configuration file -c, --config=FILE load a JSON-format configuration file
--max-cpu-usage=N maximum cpu usage for automatic threads mode (default 75)
--safe safe adjust threads and av settings for current cpu
-h, --help display this help and exit -h, --help display this help and exit
-V, --version output version information and exit -V, --version output version information and exit
``` ```
## Algorithm variations ## Algorithm variations
Since version 0.6.0. Since version 0.8.0.
* `--av=1` Default for CPUs with hardware AES. * `--av=1` For CPUs with hardware AES.
* `--av=2` [XMR-Stak-CPU](https://github.com/fireice-uk/xmr-stak-cpu) algorithm. * `--av=2` Lower power mode (double hash) of `1`.
* `--av=3` Same as `1` but uses BMI2 instruction [mulx](https://software.intel.com/sites/landingpage/IntrinsicsGuide/#text=_mulx_u64). * `--av=3` Software AES implementation.
* `--av=4` Software AES implementation. * `--av=4` Lower power mode (double hash) of `3`.
For 32 bit platform only available `1` and `4`.
## Build ## Build
### Ubuntu (Debian-based distros) ### Ubuntu (Debian-based distros)
@ -96,13 +98,16 @@ CMake options:
cmake .. -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release -DCURL_INCLUDE_DIR="c:\<path>\curl-7.53.1\include" -DCURL_LIBRARY="c:\<path>\curl-7.53.1\lib\.libs" cmake .. -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release -DCURL_INCLUDE_DIR="c:\<path>\curl-7.53.1\include" -DCURL_LIBRARY="c:\<path>\curl-7.53.1\lib\.libs"
``` ```
### Optional features
`-DWITH_LIBCPUID=OFF` Disable libcpuid. Auto configuration of CPU after this will be very limited.
`-DWITH_AEON=OFF` Disable CryptoNight-Lite support.
## Common Issues ## Common Issues
### HUGE PAGES unavailable ### HUGE PAGES unavailable
* Run XMRig as Administrator. * Run XMRig as Administrator.
* Enable SeLockMemoryPrivilege. For Windows 7 pro, or Windows 8 and above see [this article](https://msdn.microsoft.com/en-gb/library/ms190730.aspx). * Since version 0.8.0 XMRig automatically enable SeLockMemoryPrivilege for current user, but reboot or sign out still required. [Manual instruction](https://msdn.microsoft.com/en-gb/library/ms190730.aspx).
## Other information ## Other information
* Now only support 64 bit operating systems (Windows/Linux).
* No HTTP support, only stratum protocol support. * No HTTP support, only stratum protocol support.
* No TLS support. * No TLS support.
* Default donation 5% (5 minutes in 100 minutes) can be reduced to 1% via command line option `--donate-level`. * Default donation 5% (5 minutes in 100 minutes) can be reduced to 1% via command line option `--donate-level`.