Skip to content

Commit

Permalink
to ver 1.2.3a
Browse files Browse the repository at this point in the history
  • Loading branch information
DXdeja committed May 22, 2017
1 parent 4b19a59 commit 24f77ab
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 6 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# NiceHash Excavator

Excavator is GPU miner by NiceHash for mining various altcoins on [NiceHash.com](https://www.nicehash.com). Excavator is being actively developed by djeZo and zawawa. Miner is using custom built code base with modern approach and supporting modern video cards - NVIDIA and AMD. For AMD support, please see [AMD readme](amd/README.md) for important details.
Excavator is GPU miner by NiceHash for mining various altcoins on [NiceHash.com](https://www.nicehash.com) and other pools. Excavator is being actively developed by djeZo and zawawa. Miner is using custom built code base with modern approach and supporting modern video cards - NVIDIA and AMD. For AMD support, please see [AMD readme](amd/README.md) for important details.

Download from here: https://github.com/nicehash/excavator/releases

**WARNING!!! Excavator is a proprietary software by NiceHash and has a special [EULA](excavator-EULA.txt).
YOU ARE NOT ALLOWED TO REDISTRIBUTE IT!**


# How to use Excavator?
# How to Use Excavator?

**ADVANCED** There are two methods to use Excavator. Both rely on API commands you can find in file [excavator-man-API.txt](excavator-man-API.txt). Do note that API manuals are still being created and that is just an incomplete draft so far.

Expand Down Expand Up @@ -44,7 +44,7 @@ Excavator contains HTTP server. Currently, it can serve API commands and is by d
> http://bind-ip:bind-port/api?command={JSON-command-here}

# <a name="cmdline"></a> Command line parameters
# <a name="cmdline"></a> Command Line Parameters

Parameter | Range | Description | Default
-----------------|----------|----------|---------
Expand All @@ -58,13 +58,17 @@ Parameter | Range | Description | Default
-c | file name | Use commanding file |


# Additional notices
# Additional Notices

WARNING! Excavator supports overclocking. Use overclocking at your own risk. OVERCLOCKING MAY PERMANENTLY DAMAGE YOUR COMPUTER HARDWARE! If you overclock, we suggest you to set '-or' to reset clocks after miner quits. This may prevent driver crashes or freezes due to high clocks. With parameter '-od' you can adjust overclock delay and apply new clocks when mining is already happening. This can also prevent crashes or freezes due to high clocks.


# Changelog

v1.2.3a
- added algorithm OpenCL sia
- added algorithm OpenCL decred

v1.2.2a
- added algorithm CUDA sia
- general fixes and improvements
Expand Down
29 changes: 27 additions & 2 deletions amd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,10 @@ The following algorithms are currently supported:

Name | Supported devices | Wcount*1 | Pcount*2
-----------------|----------|---------|----
[equihash](#equihash) | GCN2+ | 4 to 6| 2
[pascal](#pascal) | GCN2+ | 4 | 2
[equihash](#equihash) | GCN2+ | 4 | 2
[pascal](#pascal) | GCN1+ | 4 | 3
[sia](#sia) | GCN1+ | 4 | 2
[decred](#decred) | GCN1+ | 4 | 4

*1 Recommended number of workers per device to reach optimal speeds.

Expand Down Expand Up @@ -69,5 +71,28 @@ Parameter # | Range | Explanation
-----------------|----------|---------
1 | 0-∞ | Global work size
2 | 0-256 | Local work size
3 | 0-∞ | Number of iterations

If no parameters are provided, device specific defaults are used. If provided parameter is '0' then device specific default value is used.


## <a name="sia"></a> sia

Parameter # | Range | Explanation
-----------------|----------|---------
1 | 0-∞ | Global work size
2 | 0-256 | Local work size

If no parameters are provided, device specific defaults are used. If provided parameter is '0' then device specific default value is used.


## <a name="decred"></a> decred

Parameter # | Range | Explanation
-----------------|----------|---------
1 | 0 or 1 | Disable/enable binary kernels
2 | 0-∞ | Global work size
3 | 0-256 | Local work size
4 | 0-∞ | Number of iterations

If no parameters are provided, device specific defaults are used. If provided parameter is '0' then device specific default value is used.

0 comments on commit 24f77ab

Please sign in to comment.