2016-11-11 MERGE: kost branch

.gitmodules

@@ -1,3 +1,4 @@
 [submodule "nheqminer/external/equihash-xenon"]
 	path = nheqminer/external/equihash-xenon
-	url = https://github.com/xenoncat/equihash-xenon
+	url = https://github.com/kost/equihash-xenon
+	branch = kost

Dockerfile

@@ -0,0 +1,12 @@
+FROM alpine
+
+RUN apk add --no-cache --virtual=build-dependencies git cmake make gcc g++ libc-dev boost-dev && \
+    git clone --recursive https://github.com/kost/nheqminer.git && \
+    cd /nheqminer/nheqminer && \
+    mkdir build && \
+    cd /nheqminer/nheqminer/build && \
+    cmake -DSTATIC_BUILD=1 -DXENON=2 -DMARCH="-m64" .. && \
+    make && \
+    apk del --purge build-dependencies
+
+ENTRYPOINT ["/nheqminer/nheqminer/build/nheqminer"]

README.md

@@ -2,15 +2,23 @@
 
 Equihash/zcash/zec miner (can be used for pool mining)
 
+**NOTE: Common mistake is to clone this repo without recursive, you need to use --recursive**
+
+```
+git clone --recursive https://github.com/kost/nheqminer
+```
+
+**Your build with XENON/XENONCAT will fail otherwise**
+
 # Features
 
 Major things:
-- Implemented all fast implementations (tromp and xenoncati with AVX1/AVX2) 
+- Implemented all fast implementations (tromp and xenoncat with AVX1/AVX2) 
 - Better support for other platforms
 
 Platforms:
 - Linux (tromp, xenoncat support)
-- Mac OS X (tromp so far)
+- Mac OS X (tromp and xenoncat support)
 - Windows (tromp, xenoncat but need tweaking)
 
 # Usage
@@ -44,39 +52,33 @@ Add -DXENON to cmake to build with AVX/AVX2 support.
 
 ## Options to build Fastest miner
 
-If you are building for Linux and your processor is i5 or i7 (supports AVX2), you can say something like:
+If you are building for Linux and for your processor on local machine (with AVX1/AVX2 automatically detected) , you can say something like:
 
-`cmake -DXENON=2 ..`
+`cmake -DXENON=1 ..`
 
-If you are building for Linux and your processor is i3 or xeon (supports AVX), you can say something like:
+This will build -march=native by default. 
 
-`cmake -DXENON=1 ..`
+If you need to transfer binaries to other machines and automatically detect AVX1/AVX2 or not, you can say something like:
+
+`cmake -DXENON=1 -DMARCH="-m64" ..`
 
-If you don't have AVX/AVX2 support, just build without any options:
+If you don't want to compile with AVX/AVX2 support, just build without any options:
 
 `cmake  ..`
 
+Note AVX/AVX2 binaries should automatically downgrade to tromp if nothing else found.
+
 Full example:
 ```
 sudo apt-get install cmake build-essential libboost-all-dev
 git clone --recursive https://github.com/kost/nheqminer.git
 cd nheqminer/nheqminer
 mkdir build
 cd build
-cmake -DXENON=2 ..
+cmake -DXENON=1 ..
 make
 ```
 
-## Windows:
-
-Windows builds made by us are available here: https://github.com/kost/nheqminer/releases
-
-Download and install:
-- Visual Studio 2013 Community: https://www.visualstudio.com/en-us/news/releasenotes/vs2013-community-vs
-- Visual C++ Compiler November 2013 CTP: https://www.microsoft.com/en-us/download/details.aspx?id=41151
-
-Open **nheqminer.sln** under **nheqminer/nheqminer.sln** and build.
-
 ## Linux cmake **recommended** (Tested on Ubuntu Desktop 14.04 and 16.04 and Ubuntu server 14.04):
 You should have **CMake** installed (2.8 minimal version), boost (install from the repositories or download boost manually build and install it manually), download the sources manually or via git. 
 Under Ubuntu open a terminal and run the following commands:
@@ -85,46 +87,116 @@ Under Ubuntu open a terminal and run the following commands:
   - `cd nheqminer/nheqminer`
   - `mkdir build`
   - `cd build`
-  - `cmake -DXENON=2 ..`
+  - `cmake -DXENON=1 ..`
   - `make`
 
-Note: for the fastest miner, it is recommended to use `cmake -DXENON=2 ..`
+Note: for the fastest miner, it is recommended to use `cmake -DXENON=1 ..`
+
+## Windows cmake **recommended** (Tested on Fedora 23):
+You should have **CMake** installed (2.8 minimal version), boost (install from the repositories or download boost manually build and install it manually), download the sources manually or via git. 
+Under Fedora open a terminal and run the following commands:
+  - `sudo dnf install mingw64-winpthreads-static mingw64-boost-static cmake make git`
+  - `git clone --recursive https://github.com/kost/nheqminer.git`
+  - `cd nheqminer/nheqminer`
+  - `mkdir build`
+  - `cd build`
+  - `cmake -DSTATIC_BUILD=1 -DXENON=1 -DMARCH="-m64" ..`
+  - `make`
 
-## Full static Linux cmake **recommended** (Tested on Alpine 3.4):
+## Full static Linux cmake **auto-AVX build recommended** (Tested on Alpine 3.4):
 You should have **CMake** installed (2.8 minimal version), boost (install from the repositories or download boost manually build and install it manually), download the sources manually or via git. 
 Under Alpine open a terminal and run the following commands:
   - `sudo apk add --update git cmake make gcc g++ libc-dev boost-dev`
   - `git clone --recursive https://github.com/kost/nheqminer.git`
   - `cd nheqminer/nheqminer`
   - `mkdir build`
   - `cd build`
-  - `cmake -DXENON=2 -DSTATIC_BUILD=1 ..`
+  - `cmake -DSTATIC_BUILD=1 -DXENON=1 -DMARCH="-m64" ..`
   - `make`
 
 
-## Mac OS X  (currently only Tromp, no xenoncat):
+## Mac OS X  (Tromp and Xenoncat):
 You need to have git, cmake, make and Mac OS X Developer stuff (compiler, etc).
 Under Mac open a terminal and run the following commands:
   - `git clone --recursive https://github.com/kost/nheqminer.git`
   - `cd nheqminer/nheqminer`
   - `mkdir build`
   - `cd build`
-  - `cmake -DSTATIC_BUILD=1 ..`
+  - `cmake -DXENON=1 -DSTATIC_BUILD=1 ..`
   - `make`
 
+## Linux cmake on Raspberry PI (Tested on Raspberry PI 2):
+You should have **CMake** installed (2.8 minimal version), boost (install from the repositories or download boost manually build and install it manually), download the sources manually or via git. 
+Under Raspbian open a terminal and run the following commands:
+  - `sudo apt-get install git cmake build-essential libboost-all-dev`
+  - `git clone --recursive https://github.com/kost/nheqminer.git`
+  - `cd nheqminer/nheqminer`
+  - `mkdir build`
+  - `cd build`
+  - `cmake -DNONINTEL=1 ..`
+  - `make`
+
+## Linux cmake on Raspberry PI (Tested on Alpine on Raspberry PI):
+You should have **CMake** installed (2.8 minimal version), boost (install from the repositories or download boost manually build and install it manually), download the sources manually or via git. 
+Under Alpine open a terminal and run the following commands:
+  - `sudo apk add --update git cmake make gcc g++ libc-dev boost-dev`
+  - `git clone --recursive https://github.com/kost/nheqminer.git`
+  - `cd nheqminer/nheqminer`
+  - `mkdir build`
+  - `cd build`
+  - `cmake -DNONINTEL=1 -DSTATIC_BUILD=1 ..`
+  - `make`
+
+## Windows (Microsoft Visual Studio - needs tweaking):
+Windows builds made by us are available here: https://github.com/kost/nheqminer/releases
+
+Download and install:
+- Visual Studio 2013 Community: https://www.visualstudio.com/en-us/news/releasenotes/vs2013-community-vs
+- Visual C++ Compiler November 2013 CTP: https://www.microsoft.com/en-us/download/details.aspx?id=41151
+
+Open **nheqminer.sln** under **nheqminer/nheqminer.sln** and build.
+
+## Release builds
+
+Linux on Alpine 3.4:
+```
+cmake -DXENON=1 -DSTATIC_BUILD=1 -DMARCH="-m64" ..
+```
+
+Mac OS X:
+```
+cmake -DXENON=1 -DSTATIC_BUILD=1 -DMARCH="-m64" ..
+```
+
+Windows (on Fedora 23 with MingW) (Docker: fedora:23):
+```
+cmake -DXENON=1 -DSTATIC_BUILD=1 -DMARCH="-m64" -DCMAKE_TOOLCHAIN_FILE=../toolchain-mingw64.cmake ..
+```
+
+Linux on Raspberry PI (Docker: kaffepanna/alpine-armv7-qemu):
+```
+Host: apt-get install qemu qemu-user-static binfmt-support
+cmake -DNONINTEL=1 -DSTATIC_BUILD=1 -DMARCH="-Wall" ..
+```
+
+
 # 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:
+If run without parameters, miner will start mining with 75% of available virtual cores on flypool with developers account using best engine. Feel free to donate that way. Use parameter -h to learn about available parameters:
 
+```
+Parameters:
         -h              Print this help and quit
-        -l [location]   Location (eu, usa, hk, jp)
-        -u [username]   Username (bitcoinaddress)
+        -l [location]   Stratum server:port
+        -u [username]   Username (pool worker)
+        -x [enginenum]  Engine (-1=auto,0=tromp,1=AVX1,2=AVX2)
         -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
@@ -143,7 +215,25 @@ Example to mine with your own ZEC address and worker1 on EU server, using 6 thre
 
 <i>Note: if you have a 4-core CPU with hyper threading enabled (total 8 threads) it is best to run with only 6 threads (experimental benchmarks shows that best results are achieved with 75% threads utilized)</i>
 
+
+
+
+# Acknowledgments and credits
+
+## Acknowledgements
+
+This miner is based on Equihash Miner for NiceHash
+Thanks to Zcash developers for providing most of the code
+Special thanks to tromp for providing optimized CPU equihash solver
+Special thanks to xenoncat for providing assembly optimized CPU equihash solver
+Special thanks to [Zcash Community on Slack](https://zcashcommunity.slack.com)
+
+## Credits
+
+Author of this miner: Kost
+
 ## Donations
+
 If you feel this project is useful to you. Feel free to donate.
 
     BTC address: 1KHRiwNdFiL4uFUGFEpbG7t2F3pUcttLuX