Skip to content
This repository has been archived by the owner on Jan 9, 2021. It is now read-only.

Updates Formatting #236

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Windows builds made by us are available here: https://github.com/nicehash/nheqmi

Download and install:
- [CUDA SDK](https://developer.nvidia.com/cuda-downloads) (if not needed remove **USE_CUDA_TROMP** and **USE_CUDA_DJEZO** from **nheqminer** Preprocessor definitions under Properties > C/C++ > Preprocessor)
- Visual Studio 2013 Community: https://www.visualstudio.com/en-us/news/releasenotes/vs2013-community-vs
- [Visual Studio 2013 Community](https://www.visualstudio.com/en-us/news/releasenotes/vs2013-community-vs)
- [Visual Studio Update 5](https://www.microsoft.com/en-us/download/details.aspx?id=48129) installed
- 64 bit version only

Expand All @@ -30,13 +30,13 @@ Working solvers CPU_TROMP, CPU_XENONCAT, CUDA_TROMP, CUDA_DJEZO
### General instructions:
- Install CUDA SDK v8 (make sure you have cuda libraries in **LD_LIBRARY_PATH** and cuda toolkit bins in **PATH**)
- example on Ubuntu:
- LD_LIBRARY_PATH="$LD_LIBRARY_PATH:/usr/local/cuda-8.0/lib64:/usr/local/cuda-8.0/lib64/stubs"
- PATH="$PATH:/usr/local/cuda-8.0/"
- PATH="$PATH:/usr/local/cuda-8.0/bin"
- `LD_LIBRARY_PATH="$LD_LIBRARY_PATH:/usr/local/cuda-8.0/lib64:/usr/local/cuda-8.0/lib64/stubs"`
- `PATH="$PATH:/usr/local/cuda-8.0/"`
- `PATH="$PATH:/usr/local/cuda-8.0/bin"`

- Use Boost 1.62+ (if it is not available from the repos you will have to download and build it yourself)
- CMake v3.5 (if it is not available from the repos you will have to download and build it yourself)
- Currently support only static building (CPU_XENONCAT, CUDA_DJEZO are enabled by default, check **CMakeLists.txt** in **nheqminer** root folder)
- Currently support only static building (`CPU_XENONCAT`, `CUDA_DJEZO` are enabled by default, check **CMakeLists.txt** in **nheqminer** root folder)
- If not on Ubuntu make sure you have **fasm** installed and accessible in **PATH**
- After that open the terminal and run the following commands:
- `git clone https://github.com/nicehash/nheqminer.git`
Expand All @@ -55,24 +55,31 @@ Working solvers CPU_TROMP, CPU_XENONCAT, CUDA_TROMP, CUDA_DJEZO

# Run instructions:

Parameters:
Parameters:
```
-h Print this help and quit
-l [location] Stratum server:port
-u [username] Username (bitcoinaddress)
-a [port] Local API port (default: 0 = do not bind)
-d [level] Debug print level (0 = print all, 5 = fatal only, default: 2)
-b [hashes] Run in benchmark mode (default: 200 iterations)
```

CPU settings
```
-t [num_thrds] Number of CPU threads
-e [ext] Force CPU ext (0 = SSE2, 1 = AVX, 2 = AVX2)
```

NVIDIA CUDA settings
```
-ci CUDA info
-cd [devices] Enable CUDA mining on spec. devices
-cb [blocks] Number of blocks
-ct [tpb] Number of threads per block
Example: -cd 0 2 -cb 12 16 -ct 64 128
```

Example: `-cd 0 2 -cb 12 16 -ct 64 128`

If run without parameters, miner will start mining with 75% of available logical CPU cores. Use parameter -h to learn about available parameters:

Expand Down