Update README.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
diff --git a/README b/README
index 79dfcd6..76bb86e 100644
--- a/README
+++ b/README
@@ -1,5 +1,18 @@
-This is a multi-threaded multi-pool CPU and GPU miner for bitcoin.
+This is a multi-threaded multi-pool CPU and GPU miner for bitcoin and
+derivative coins.
+
+GIT TREE:
+
+https://github.com/ckolivas/cgminer
+
+Support thread:
+
+http://forum.bitcoin.org/index.php?topic=28402.0
+
+IRC Channel:
+
+irc://irc.freenode.net/cgminer
License: GPLv2. See COPYING for details.
@@ -139,11 +152,10 @@ The efficiency defined as the accepted shares / requested work
The utility defines as the number of shares / minute
The cgminer status line shows:
- TQ: 1 ST: 1 LS: 0 SS: 0 DW: 0 NB: 1 LW: 8 LO: 1 RF: 1 I: 2
+ TQ: 1 ST: 1 SS: 0 DW: 0 NB: 1 LW: 8 LO: 1 RF: 1 I: 2
TQ is Total Queued work items.
ST is STaged work items (ready to use).
-LS is Longpoll Staged work items (mandatory new work)
SS is Stale Shares discarded (detected and not submitted so don't count as rejects)
DW is Discarded Work items (work from block no longer valid to work on)
NB is New Blocks detected on the network
@@ -195,7 +207,52 @@ if you use
./cgminer -o xxx -u yyy -p zzz 2>logfile.txt
it will log to a file called logfile.txt and otherwise work the same.
+
+There is also the -m option on linux which will spawn a command of your choice
+and pipe the output directly to that command.
+
---
+FAQ
+
+Q: cgminer segfaults when I change my shell window size.
+A: Older versions of libncurses have a bug to do with refreshing a window
+after a size change. Upgrading to a new version of curses will fix it.
+
+Q: Can I mine on servers from different networks (eg smartcoin and bitcoin) at
+the same time?
+A: No, cgminer keeps a database of the block it's working on to ensure it does
+not work on stale blocks, and having different blocks from two networks would
+make it invalidate the work from each other.
+
+Q: Can I change the settings individually for each GPU?
+A: Not currently.
+
+Q: Can I put multiple pools in the json config file?
+A: Not currently, but you can use multiple config files and specify each with
+successive -c. e.g.: cgminer -c cfg1.json -c cfg2.json
+
+Q: The build fails with gcc is unable to build a binary.
+A: Remove the "-march=native" component of your CFLAGS as your version of gcc
+does not support it.
+
+Q: The CPU usage is high.
+A: If you're on linux, the ATI drivers after 11.6 have a bug that makes them
+consume 100% of one CPU core unnecessarily so downgrade to 11.6. If you're on
+windows, you may be out of luck because the pthread library used consumes a
+lot of CPU.
+
+Q: Can you implement feature X?
+A: I can, but time is limited, and people who donate are more likely to get
+their feature requests implemented.
+
+Q: My GPU hangs and I have to reboot it to get it going again?
+A: The more aggressively the mining software uses your GPU, the less overclock
+you will be able to run. You are more likely to hit your limits with cgminer
+and you will find you may need to overclock your GPU less aggressively. The
+software cannot be responsible and make your GPU hang directly.
+
+---
+
This code is provided entirely free of charge by the programmer in his spare
time so donations would be greatly appreciated.