Newbie

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "jansson"]
+  path = submodules/jansson
+  url = https://github.com/akheron/jansson.git
+

AUTHORS.md

@@ -2,35 +2,47 @@
 
 ## Core
 
-* Scrypt-only refactor and maintenance: Noel Maersk <veox at wemakethings dot net> LfxRFgXzA13TSTxgFGUFEtumv5ShGzAmLw
-* Core: Martin Danielsen <kalroth {at} gmail _dot_ com> 1DNBcSEENBwDKrcTyTW61ezWhzsPy5imkn
-* Core: Con Kolivas <kernel [at] kolivas {dot} org> 15qSxP1SQcUX3o4nhkfdbgyoWEFMomJ4rZ
-* Core: Luke Dashjr <luke-jr+cgminer @at@ utopios .dot. org> 1QATWksNFGeUJCWBrN4g6hGM178Lovm7Wh
-* API: Andrew Smith <kan0i {at} kano-kun [dot] net> 1Jjk2LmktEQKnv8r2cZ9MvLiZwZ9gxabKm
+* Jan Berdajs <mrbrdo at mrbrdo dot net> 15bULC8snaKAMeFb3xBmmhbWj1xyTmBUfm
+* Noel Maersk <veox at wemakethings dot net> 12jF1VExtmmMu8D36vo4Y4CYqLK5yCtLC4
+* troky <troky2001 at yahoo dot com> 1DqHeJdVy4kQX1jHaaVxef9Bgii14pwEbg
+* Yann St.Arnaud <ystarnaud at gmail dot com> 1SLixz2vRvjdpzZTep4Tiqs82Jc28tc6J
+* lasybear <**FIXME**>
+* Luke Dashjr <luke-jr+cgminer @at@ utopios .dot. org> 1QATWksNFGeUJCWBrN4g6hGM178Lovm7Wh
+* Andrew Smith <kan0i {at} kano-kun [dot] net> 1Jjk2LmktEQKnv8r2cZ9MvLiZwZ9gxabKm
+
+
+## Core (history)
+
+* Con Kolivas <kernel [at] kolivas {dot} org> 15qSxP1SQcUX3o4nhkfdbgyoWEFMomJ4rZ
+* Martin Danielsen <kalroth {at} gmail _dot_ com> 1DNBcSEENBwDKrcTyTW61ezWhzsPy5imkn
 
 
 ## Cross-platform support
 
 * MinGW (Windows native): Drogean <Drogean>
 * MinGW (Linux cross-compilation): Wolf` <wolf9466>
 * MinGW (Linux cross-compilation): tonobitc <tonobitc>
-* MSVS2010: troky <troky2001 at yahoo dot com> Letoqz4yEnJxjWw9B7Ysn8h9VDQTMDnT29
+* MSVS2010: troky <troky2001 at yahoo dot com>
 * Cygwin: Markus Peloquin <markuspeloquin>
 
 
 ## OpenCL kernels
 
+**FIXME**: this section is outdated.
+
 All current kernels are based on `scrypt`, originally by Colin Percival,
 updated by many others.
 
 * alexkarnew/alexkarold: Alexey Karimov LMqRcHdwnZtTMH6c2kWoxSoKM5KySfaP5C
+* bufius: Bufius VvvmmkYHKGtdr97JLyyZuJ3Th5ayungnjk
 * ckolivas: Con Kolivas <kernel @at@ kolivas }dot{ org> 15qSxP1SQcUX3o4nhkfdbgyoWEFMomJ4rZ
 * psw: Pavel Semjanov LP6GRFvgoMxKA6AW4TVF668cNezEGZvEtr
 * zuikkis: Zuikkis LeXck7EYgxyjw13zNDxZFmmgmWffFvhmSh
 
 
 ## Testing, bug fixes, improvements
 
+* Michael Fiano <mfiano>
 * Gabriel Devenyi <gdevenyi>
 * Benjamin Herrenschmidt <ozbenh>
 * Joe4782 <Joe4782>
@@ -40,12 +52,17 @@ updated by many others.
 * tonobitc <tonobitc>
 * Perry Huang <perryh>
 * Joseph Bruggeman <jbruggeman>
+* Badman74 <badman74>
+* djm34 <djm4>
 
 ...and many others. See:
 
-* [veox/sgminer](https://github.com/veox/sgminer/graphs/contributors)
-
+* [sgminer-dev/sgminer](https://github.com/sgminer-dev/sgminer/graphs/contributors)
 
 ## Legacy
 
 * Original CPU mining software: Jeff Garzik <jgarzik@pobox.com>
+
+## Sponsors and acknowledgments
+
+* nicehash.com - sponsored adding/merging many additional algorithms including X11 and Keccak, stratum extranonce

Makefile.am

@@ -1,22 +1,22 @@
 
 ACLOCAL_AMFLAGS = -I m4
 
-JANSSON_CPPFLAGS= -I$(top_builddir)/compat/jansson-2.5/src -I$(top_srcdir)/compat/jansson-2.5/src
+JANSSON_CPPFLAGS= -I$(top_builddir)/submodules/jansson/src -I$(top_srcdir)/submodules/jansson/src
 
 EXTRA_DIST	= example.conf m4/gnulib-cache.m4 \
 		  ADL_SDK/readme.txt api-example.php miner.php	\
 		  API.class API.java api-example.c hexdump.c \
 		  doc/API doc/FAQ doc/GPU doc/SCRYPT doc/windows-build.txt
 
-SUBDIRS		= lib compat ccan
+SUBDIRS		= lib submodules ccan sph
 
 bin_PROGRAMS     = sgminer
 
-sgminer_CPPFLAGS = $(PTHREAD_FLAGS) -fno-strict-aliasing $(JANSSON_CPPFLAGS)
+sgminer_CPPFLAGS = $(PTHREAD_FLAGS) -std=gnu99 $(JANSSON_CPPFLAGS)
 sgminer_LDFLAGS  = $(PTHREAD_FLAGS)
 sgminer_LDADD    = $(DLOPEN_FLAGS) @LIBCURL_LIBS@ @JANSSON_LIBS@ @PTHREAD_LIBS@ \
 		  @OPENCL_LIBS@ @NCURSES_LIBS@ @PDCURSES_LIBS@ @WS2_LIBS@ \
-		  @MM_LIBS@ @RT_LIBS@ @MATH_LIBS@ lib/libgnu.a ccan/libccan.a
+		  @MM_LIBS@ @RT_LIBS@ @MATH_LIBS@ lib/libgnu.a ccan/libccan.a sph/libsph.a
 
 sgminer_CPPFLAGS += -I$(top_builddir)/lib -I$(top_srcdir)/lib @OPENCL_FLAGS@
 
@@ -32,17 +32,44 @@ sgminer_CPPFLAGS += -DGIT_VERSION=\"$(GIT_VERSION)\"
 endif
 
 sgminer_SOURCES := sgminer.c
-sgminer_SOURCES	+= api.c
+sgminer_SOURCES	+= api.c api.h
 sgminer_SOURCES	+= elist.h miner.h compat.h bench_block.h
 sgminer_SOURCES	+= util.c util.h uthash.h
-sgminer_SOURCES	+= sha2.c sha2.h
 sgminer_SOURCES	+= logging.c logging.h
 sgminer_SOURCES += driver-opencl.c driver-opencl.h
 sgminer_SOURCES += ocl.c ocl.h
 sgminer_SOURCES += findnonce.c findnonce.h
 sgminer_SOURCES += adl.c adl.h adl_functions.h
-sgminer_SOURCES += scrypt.c scrypt.h
+sgminer_SOURCES += pool.c pool.h
+sgminer_SOURCES += algorithm.c algorithm.h
+sgminer_SOURCES += config_parser.c config_parser.h
+sgminer_SOURCES += events.c events.h
+sgminer_SOURCES += ocl/build_kernel.c ocl/build_kernel.h
+sgminer_SOURCES += ocl/binary_kernel.c ocl/binary_kernel.h
+
 sgminer_SOURCES += kernel/*.cl
+sgminer_SOURCES += algorithm/scrypt.c algorithm/scrypt.h
+sgminer_SOURCES += algorithm/darkcoin.c algorithm/darkcoin.h
+sgminer_SOURCES += algorithm/qubitcoin.c algorithm/qubitcoin.h
+sgminer_SOURCES += algorithm/quarkcoin.c algorithm/quarkcoin.h
+sgminer_SOURCES += algorithm/myriadcoin-groestl.c algorithm/myriadcoin-groestl.h
+sgminer_SOURCES += algorithm/fuguecoin.c algorithm/fuguecoin.h
+sgminer_SOURCES += algorithm/inkcoin.c algorithm/inkcoin.h
+sgminer_SOURCES += algorithm/animecoin.c algorithm/animecoin.h
+sgminer_SOURCES += algorithm/groestlcoin.c algorithm/groestlcoin.h
+sgminer_SOURCES += algorithm/sifcoin.c algorithm/sifcoin.h
+sgminer_SOURCES += algorithm/twecoin.c algorithm/twecoin.h
+sgminer_SOURCES += algorithm/marucoin.c algorithm/marucoin.h
+sgminer_SOURCES += algorithm/maxcoin.c algorithm/maxcoin.h
+sgminer_SOURCES += algorithm/talkcoin.c algorithm/talkcoin.h
+sgminer_SOURCES += algorithm/bitblock.c algorithm/bitblock.h
+sgminer_SOURCES += algorithm/x14.c algorithm/x14.h
+sgminer_SOURCES += algorithm/fresh.c algorithm/fresh.h
+sgminer_SOURCES += algorithm/whirlcoin.c algorithm/whirlcoin.h
+sgminer_SOURCES += algorithm/neoscrypt.c algorithm/neoscrypt.h
+sgminer_SOURCES += algorithm/whirlpoolx.c algorithm/whirlpoolx.h
+sgminer_SOURCES += algorithm/lyra2re.c algorithm/lyra2re.h algorithm/lyra2.c algorithm/lyra2.h algorithm/sponge.c algorithm/sponge.h
+sgminer_SOURCES += algorithm/pluck.c algorithm/pluck.h
 
 bin_SCRIPTS	= $(top_srcdir)/kernel/*.cl
 

NEWS.md

@@ -1,8 +1,97 @@
 # Release news
 
-## Version 4.2.0 - TBA
+## Version 5.0.0 - 2nd September 2014
 
-* Forward-port changes from `ckolivas/cgminer` up to 3.12.1.
+* Added support for animecoin, darkcoin, fuguecoin, groestlcoin, inkcoin,
+  marucoin, myriadcoin-groestl, quarkcoin, qubitcoin, sifcoin, twecoin,
+  darkcoin-mod ("X11-mod"), marucoin-mod ("X13-mod"), maxcoin (by
+  _mrbrdo_).
+* `intensity`, `xintensity`, `rawintensity`, `gpu-memclock`,
+  `gpu-engine`, `thread-concurrency`, `gpu-threads` now also have a
+  `pool-*` version to configure them for each pool separately
+  (by _mrbrdo_).
+* Initial configuration system revamping (by _ystarnaud_).
+* Algorithm profile configuration (by _ystarnaud_).
+* Complete configuration documentation, see `doc/configuration.md` (by
+  _ystarnaud_).
+* API documentation update, see `doc/API.md` (by _ystarnaud_).
+* Extranonce support for stratum (by _bitbandi_).
+
+
+## Version 4.2.2 - 27th June 2014
+
+* Fixes for a few stratum-related security vulnerabilities (reported by
+  _Mick Ayzenberg_ of DejaVu Security).
+* Found blocks calculation fix (by _troky_).
+
+
+## Version 4.2.1 - 22nd May 2014
+
+* Fixed MSVS building, tested with MSVC++ 2010 and 2013 (by _troky_).
+* Added the "ultratune" feature from `sph-sgminer`, available in the
+  NCurses interface with `[G][C][U]` (by _ultracorp_).
+
+
+## Version 4.2.0 - 20th May 2014
+
+* git repo moved to [sgminer-dev](https://github.com/sgminer-dev/sgminer).
+  It is now a GitHub organisation with several people having write access.
+* Kernel `bufius` merger from `vertminer` (by _Bufius_).
+* Set pool as idle on several stratum failure conditions (by _elbandi_).
+* API response to `version` has field `CGMiner` instead of `SGMiner`
+  for API client compatibility, and an additional `Miner` field (by
+  _luke-jr_).
+* API response to `restart` and `quit` only contains a `status` section
+  and passes JSON validation (by _luke-jr_).
+* API response to `devs` contains `XIntensity` and `RawIntensity` fields.
+* Config file writing from TUI/API should produce a borked config less
+  often.
+
+
+## Version 4.1.271 - 12th April 2014
+
+* Allow setting algorithm per-pool and initial implementation of kernel
+  hot-swapping (by _mrbrdo_). Use options `pool-algorithm` (in config
+  file or in CLI) or `algorithm` (config-only).
+* NCurses UI `[S][W]` writes pool name and description to configuration.
+* Added algorithm name to `pools` API command (by _troky_).
+* NCurses UI asks for (optional) pool name, description and algorithm
+  when adding pool.
+* API command `addpool` allows both `url,user,pass` and
+  `url,user,pass,name,desc,algo`.
+
+
+## Version 4.1.242 - 7th April 2014
+
+* There are now two mailing lists (on SourceForge), see `README.md`.
+* Adaptive-N-factor algorithm support (by _Bufius_, _Zuikkis_ and
+  _veox_). For details on choosing the algorithm, see
+  `doc/configuration.md`.
+* Allowed kernel names are no longer hard-coded. It is now possible to
+  use any `.cl` file.
+* Configuration parameter `poolname` has been renamed to `name`.
+  `poolname` is deprecated and will be removed in a future version.
+* Multiple `--name` parsing should now work as expected (by _troky_).
+* `--description` configuration parameter to specify a freeform pool
+  description, and `--priority` to specify the pool's priority (by
+  _troky_).
+
+
+## Version 4.1.153 - 14th March 2014
+
+* Display pool URL instead of "Pool N" if no `poolname` specified.
+* Incognito mode to hide user name in NCurses interface - useful for
+  publishing screenshots. To enable, use `--incognito` on command line,
+  `incognito` in config or `[D][I]` in NCurses interface.
+* Support building in Microsoft Visual Studio 2010, perhaps other
+  versions as well (by _troky_). Documentation in `winbuild/README.txt`.
+* Support building in Cygwin (by _markuspeloquin_). Documentation in
+  `doc/cygwin-build.txt`.
+* Forward-port changes from `ckolivas/cgminer` up to 3.12.3.
+* Allow setting `worksize` for kernel `zuikkis`.
+* More log messages in pool handling.
+* Updated `doc/FAQ.md`.
+* Updated `example.conf`.
 
 
 ## Version 4.1.0 - 7th February 2014

README.md

@@ -4,33 +4,42 @@
 ## Introduction
 
 This is a multi-threaded multi-pool GPU miner with ATI GPU monitoring,
-(over)clocking and fanspeed support for scrypt-based coins. It is based on
-cgminer by Con Kolivas (ckolivas), which is in turn based on cpuminer by
-Jeff Garzik (jgarzik).
+(over)clocking and fanspeed support for scrypt-based cryptocurrency. It is
+based on cgminer by Con Kolivas (ckolivas), which is in turn based on
+cpuminer by Jeff Garzik (jgarzik).
 
-**releases**: https://github.com/veox/sgminer/releases
+**releases**: https://github.com/sgminer-dev/sgminer/releases
 
-**git tree**: https://github.com/veox/sgminer
+**git tree**: https://github.com/sgminer-dev/sgminer
 
-**issues**: https://github.com/veox/sgminer/issues
+**bugtracker**: https://github.com/sgminer-dev/sgminer/issues
 
-**irc**: `#sgminer` on freenode
+**irc**: `#sgminer` and `#sgminer-dev` on freenode
+
+**mailing lists**: https://sourceforge.net/p/sgminer/mailman/
 
 License: GPLv3.  See `COPYING` for details.
 
 
 ## Documentation
 
-Documentation is available in directory `doc`. For details on several topics, see:
+Documentation is available in directory `doc`. It is organised by topics:
 
 * `API` for the RPC API specification;
+* `configuration.md` for (largely incomplete) detailed information on all
+  configuration options;
 * `FAQ.md` for frequently asked questions;
-* `GPU` for semi-obsolete information on GPU configuration options and mining SHA256d-based coins;
-* `KERNEL.md` for OpenCL kernel-related information;
-* `MINING.md` for how to find the right balance in GPU configuration to mine Scrypt-based coins effectively;
+* `GPU` for semi-obsolete information on GPU configuration options and mining
+  SHA256d-based coins;
+* `kernel.md` for OpenCL kernel-related information, including development
+  procedure;
+* `MINING.md` for how to find the right balance in GPU configuration to mine
+  Scrypt-based coins efficiently;
 * `windows-build.txt` for information on how to build on Windows.
 
-Note that **most of the documentation is outdated**. If you want to contribute, fork this repository, update as needed, and submit a pull request.
+Note that **most of the documentation is outdated or incomplete**. If
+you want to contribute, fork this repository, update as needed, and
+submit a pull request.
 
 
 ## Building
@@ -60,28 +69,40 @@ sgminer-specific configuration options:
 	--disable-adl-checks
     --without-curses        Do not compile support for curses TUI
 
+#### Debian Example
+
+    apt-get install libcurl4-openssl-dev pkg-config libtool libncurses5-dev
+AMD APP SDK and AMD ADL SDK must be downloaded from the amd websites.
+
 ### *nix build instructions
 
 If needed, place include headers (`*.h` files) from `ADL_SDK_*<VERSION>*.zip` in `sgminer/ADL_SDK`.
 
 Then:
 
+    git submodule init
+    git submodule update
     autoreconf -i
-    CFLAGS="-O2 -Wall -march=native" ./configure <options>
+    CFLAGS="-O2 -Wall -march=native -std=gnu99" ./configure <options>
     make
 
 To compile a version that can be used accross machines, remove
 `-march=native`.
 
 To compile a debug version, replace `-O2` with `-ggdb`.
 
+Depending on your environment, replace `-std=gnu99` with `-std=c99`.
+
 Systemwide installation is optional. You may run `sgminer` from the build
 directory directly, or `make install` if you wish to install
 `sgminer` to a system location or a location you specified with `--prefix`.
 
 ### Windows build instructions
 
-See `doc/windows-build.txt` (might be outdated).
+See `doc/windows-build.txt` for MinGW compilation and cross-compiation,
+`doc/cygwin-build.txt` for building using Cygwin, or use the provided
+`winbuild` Microsoft Visual Studio project (tested on MSVS2010), with
+instructions in `winbuild/README.txt`.
 
 
 ## Basic Usage
@@ -400,8 +421,9 @@ file and any changes that may have been made.
 
 sgminer will log to stderr if it detects stderr is being redirected to a
 file. To enable logging simply append `2>logfile.txt` to your command line
-and `logfile.txt` will contain the logged output at the log level you
-specify (normal, verbose, debug etc.)
+and `logfile.txt` will contain all debug output unless you set `debug-log`
+to `false`, in which case it will only contain output at the log level you
+specified (notice by default).
 
 There is also the -m option on Linux which will spawn a command of your choice
 and pipe the output directly to that command.