1
0
mirror of https://github.com/GOSTSec/sgminer synced 2025-02-01 01:14:22 +00:00

doc: update README.md doc list, rename KERNEL.md to kernel.md.

This commit is contained in:
Noel Maersk 2014-03-17 22:13:18 +02:00
parent 9b68b2773c
commit 41f994886e
2 changed files with 14 additions and 6 deletions

View File

@ -21,16 +21,23 @@ 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
@ -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,
`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