From ab584f7d08e57a32911894aa31c1176a98dfb0b8 Mon Sep 17 00:00:00 2001 From: nicehashdev Date: Thu, 20 Oct 2016 20:00:17 +0200 Subject: [PATCH] Update README.md --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4abb31f25..ee0be9938 100644 --- a/README.md +++ b/README.md @@ -14,4 +14,29 @@ Open a terminal and cd to nheqminer root folder and run the following commands ( - `make` ## Linux (non Ubuntu/Debian based distros): -If you are using a Linux distribution that is not Ubuntu/Debian based you can still build but you will have to build boost 1.68 and copy the static libraries [**libboost_log.a** **libboost_system.a** **libboost_thread.a**] over to **nheqminer/libs/linux_ubuntu** and follow the Ubuntu/Debian instructions (installing qt5 qmake accordingly to systems package manager). \ No newline at end of file +If you are using a Linux distribution that is not Ubuntu/Debian based you can still build but you will have to build boost 1.68 and copy the static libraries [**libboost_log.a** **libboost_system.a** **libboost_thread.a**] over to **nheqminer/libs/linux_ubuntu** and follow the Ubuntu/Debian instructions (installing qt5 qmake accordingly to systems package manager). + +# Run instructions: + +If run without parameters, miner will start mining with 75% of available virtual cores on NiceHash. Use parameter -h to learn about available parameters: + + -h Print this help and quit + -l [location] Location (eu, usa, hk, jp) + -u [username] Username (bitcoinaddress) + -p [password] Password (default: x) + -t [num_thrds] Number of threads (default: number of sys cores) + -d [level] Debug print level (0 = print all, 5 = fatal only, default: 2) + -b [hashes] Run in benchmark mode (default: 100 hashes) + -a [port] Local API port (default: 0 = do not bind) + +Example to run benchmark: + + nheqminer_x64_AVX.exe -b + +Example to run with full logging (including network dump): + + nheqminer_x64_AVX.exe -d 0 + +Example to mine with your own BTC address and worker1 on USA server: + + nheqminer_x64_AVX.exe -l usa -u YOUR_BTC_ADDRESS_HERE.worker1