From 41f994886e995528d6dc3d4c6dd9dc37d9821840 Mon Sep 17 00:00:00 2001 From: Noel Maersk Date: Mon, 17 Mar 2014 22:13:18 +0200 Subject: [PATCH] doc: update README.md doc list, rename KERNEL.md to kernel.md. --- README.md | 20 ++++++++++++++------ doc/{KERNEL.md => kernel.md} | 0 2 files changed, 14 insertions(+), 6 deletions(-) rename doc/{KERNEL.md => kernel.md} (100%) diff --git a/README.md b/README.md index 4808c145..ee92dd68 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/doc/KERNEL.md b/doc/kernel.md similarity index 100% rename from doc/KERNEL.md rename to doc/kernel.md