Browse Source

more documentation

djm34
Jan Berdajs 11 years ago
parent
commit
33023de410
  1. 5
      AUTHORS.md
  2. 10
      NEWS.md
  3. 33
      doc/configuration.md
  4. 30
      doc/kernel.md

5
AUTHORS.md

@ -2,6 +2,7 @@
## Core ## Core
* Multiple algorithms and switching: Jan Berdajs <mrbrdo at mrbrdo dot net> 15bULC8snaKAMeFb3xBmmhbWj1xyTmBUfm
* Scrypt-only refactor: Noel Maersk <veox at wemakethings dot net> LfxRFgXzA13TSTxgFGUFEtumv5ShGzAmLw * Scrypt-only refactor: Noel Maersk <veox at wemakethings dot net> LfxRFgXzA13TSTxgFGUFEtumv5ShGzAmLw
* Core: Martin Danielsen <kalroth {at} gmail _dot_ com> 1DNBcSEENBwDKrcTyTW61ezWhzsPy5imkn * Core: Martin Danielsen <kalroth {at} gmail _dot_ com> 1DNBcSEENBwDKrcTyTW61ezWhzsPy5imkn
* Core: Con Kolivas <kernel [at] kolivas {dot} org> 15qSxP1SQcUX3o4nhkfdbgyoWEFMomJ4rZ * Core: Con Kolivas <kernel [at] kolivas {dot} org> 15qSxP1SQcUX3o4nhkfdbgyoWEFMomJ4rZ
@ -32,7 +33,7 @@ updated by many others.
## Testing, bug fixes, improvements ## Testing, bug fixes, improvements
* Hot-switching OpenCL kernel (N-Factor): Jan Berdajs <mrbrdo> 15bULC8snaKAMeFb3xBmmhbWj1xyTmBUfm * Hot-switching OpenCL kernel (N-Factor): Jan Berdajs <mrbrdo>
* Michael Fiano <mfiano> * Michael Fiano <mfiano>
* Gabriel Devenyi <gdevenyi> * Gabriel Devenyi <gdevenyi>
* Benjamin Herrenschmidt <ozbenh> * Benjamin Herrenschmidt <ozbenh>
@ -46,7 +47,7 @@ updated by many others.
...and many others. See: ...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 ## Legacy

10
NEWS.md

@ -1,5 +1,15 @@
# Release news # Release news
## Master
* Added support for animecoin, darkcoin, fuguecoin, groestlcoin, inkcoin,
marucoin, myriadcoin-groestl, quarkcoin, qubitcoin, sifcoin, twecoin,
darkcoin-mod ("X11-mod" kernel), 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).
* Extranonce support for stratum (by bitbandi).
## Version 4.2.1 - 22nd May 2014 ## Version 4.2.1 - 22nd May 2014
* Fixed MSVS building, tested with MSVC++ 2010 and 2013 (by _troky_). * Fixed MSVS building, tested with MSVC++ 2010 and 2013 (by _troky_).

33
doc/configuration.md

@ -44,27 +44,18 @@ If you use any of these options for a pool, then **you must** set that option
for every pool. This is necessary due to current poor implementation of for every pool. This is necessary due to current poor implementation of
sgminer config parser. sgminer config parser.
### pool-algorithm Options that can be configured have a `pool-` prefix and work the same as the
global settings:
Allows choosing the algorithm for a specific pool. See `algorithm`.
* pool-algorithm
### pool-nfactor * pool-nfactor
* pool-intensity
Overrides the default scrypt parameter N for a specific pool. * pool-xintensity
See `nfactor`. * pool-rawintensity
* pool-gpu-engine
### pool-intensity * pool-gpu-memclock
* pool-gpu-threads
Overrides intensity. See `intensity`. * pool-thread-concurrency
### pool-xintensity
Overrides xintensity. See `xintensity`.
### pool-rawintensity
Overrides rawintensity. See `rawintensity`.
## CLI-only options ## CLI-only options

30
doc/kernel.md

@ -4,7 +4,6 @@
See directory `kernel`. See directory `kernel`.
## Parameter configuration ## Parameter configuration
### Common ### Common
@ -16,7 +15,9 @@ such as (but not necessarily limited to) `thread-concurrency`, `intensity`,
A description of how to do this is available in `doc/MINING.md`. A description of how to do this is available in `doc/MINING.md`.
### alexkarnew ### Scrypt kernels
#### alexkarnew
Alexey Karimov's optimised kernel, based on `ckolivas`. For Catalyst >=13.4. Alexey Karimov's optimised kernel, based on `ckolivas`. For Catalyst >=13.4.
@ -25,7 +26,7 @@ Only supports `vectors=1`.
[Announcement](https://litecointalk.org/index.php?topic=4082.0). [Announcement](https://litecointalk.org/index.php?topic=4082.0).
### alexkarold #### alexkarold
Alexey Karimov's optimised kernel, based on `ckolivas`. For Catalyst <13.4. Alexey Karimov's optimised kernel, based on `ckolivas`. For Catalyst <13.4.
@ -34,14 +35,14 @@ Only supports `vectors=1`.
[Announcement](https://litecointalk.org/index.php?topic=4082.0). [Announcement](https://litecointalk.org/index.php?topic=4082.0).
### bufius #### bufius
Bufius' optimised kernel, based on `ckolivas`. Merged from vertminer. Bufius' optimised kernel, based on `ckolivas`. Merged from vertminer.
Only supports `vectors=1` and `lookup-gap` 2, 4 or 8. Only supports `vectors=1` and `lookup-gap` 2, 4 or 8.
### ckolivas #### ckolivas
The original Colin Percival `scrypt` kernel, maintained for a long time by The original Colin Percival `scrypt` kernel, maintained for a long time by
Con Kolivas in `cgminer` and renamed to reflect the fact. Con Kolivas in `cgminer` and renamed to reflect the fact.
@ -49,14 +50,14 @@ Con Kolivas in `cgminer` and renamed to reflect the fact.
Only supports `vectors=1`. Only supports `vectors=1`.
### psw #### psw
Pavel Semjanov optimised kernel, SHA256 speedups. Pavel Semjanov optimised kernel, SHA256 speedups.
[Announcement](https://bitcointalk.org/index.php?topic=369858.0). [Announcement](https://bitcointalk.org/index.php?topic=369858.0).
### zuikkis #### zuikkis
Zuikkis' optimised kernel, based on `ckolivas`. Zuikkis' optimised kernel, based on `ckolivas`.
@ -64,6 +65,21 @@ Only supports `vectors=1` and `lookup-gap=2`.
[Announcement](https://litecointalk.org/index.php?topic=6058.msg90873#msg90873). [Announcement](https://litecointalk.org/index.php?topic=6058.msg90873#msg90873).
### Other kernels
#### darkcoin
#### darkcoin-mod
#### animecoin
#### fuguecoin
#### groestlcoin
#### inkcoin
#### marucoin
#### myriadcoin-groestl
#### quarkcoin
#### qubitcoin
#### sifcoin
#### twecoin
#### maxcoin
## Submitting new kernels ## Submitting new kernels

Loading…
Cancel
Save