|
|
@ -21,16 +21,23 @@ License: GPLv3. See `COPYING` for details. |
|
|
|
|
|
|
|
|
|
|
|
## Documentation |
|
|
|
## 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; |
|
|
|
* `API` for the RPC API specification; |
|
|
|
|
|
|
|
* `configuration.md` for (largely incomplete) detailed information on all |
|
|
|
|
|
|
|
configuration options; |
|
|
|
* `FAQ.md` for frequently asked questions; |
|
|
|
* `FAQ.md` for frequently asked questions; |
|
|
|
* `GPU` for semi-obsolete information on GPU configuration options and mining SHA256d-based coins; |
|
|
|
* `GPU` for semi-obsolete information on GPU configuration options and mining |
|
|
|
* `KERNEL.md` for OpenCL kernel-related information; |
|
|
|
SHA256d-based coins; |
|
|
|
* `MINING.md` for how to find the right balance in GPU configuration to mine Scrypt-based coins effectively; |
|
|
|
* `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. |
|
|
|
* `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 |
|
|
|
## Building |
|
|
@ -83,7 +90,8 @@ directory directly, or `make install` if you wish to install |
|
|
|
|
|
|
|
|
|
|
|
See `doc/windows-build.txt` for MinGW compilation and cross-compiation, |
|
|
|
See `doc/windows-build.txt` for MinGW compilation and cross-compiation, |
|
|
|
`doc/cygwin-build.txt` for building using Cygwin, or use the provided |
|
|
|
`doc/cygwin-build.txt` for building using Cygwin, or use the provided |
|
|
|
`winbuild` Microsoft Visual Studio project (tested on MSVS2010). |
|
|
|
`winbuild` Microsoft Visual Studio project (tested on MSVS2010), with |
|
|
|
|
|
|
|
instructions in `winbuild/README.txt`. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Basic Usage |
|
|
|
## Basic Usage |
|
|
|