Browse Source

Documentation.

Con Kolivas 14 years ago
parent
commit
6de8de3e0e
2 changed files with 38 additions and 2 deletions
  1. 20 0
      NEWS
  2. 18 2
      README

+ 20 - 0
NEWS

@@ -1,3 +1,23 @@
+Version 1.3.0 - July 19, 2011
+
+- Massive infrastructure update to support pool failover.
+- Accept multiple parameters for url, user and pass and set up structures of
+pool data accordingly.
+- Probe each pool for what it supports.
+- Implement per pool feature support according to rolltime support as
+advertised by server.
+- Do switching automatically based on a 300 second timeout of locally generated
+work or 60 seconds of no response from a server that doesn't support rolltime.
+- Implement longpoll server switching.
+- Keep per-pool data and display accordingly.
+- Make sure cgminer knows how long the pool has actually been out for before
+deeming it a prolonged outage.
+- Fix bug with ever increasing staged work in 1.2.8 that eventually caused
+infinite rejects.
+- Make warning about empty http requests not show by default since many
+servers do this regularly.
+
+
 Version 1.2.8 - July 18, 2011
 Version 1.2.8 - July 18, 2011
 
 
 - More OSX build fixes.
 - More OSX build fixes.

+ 18 - 2
README

@@ -1,5 +1,5 @@
 
 
-This is a multi-threaded CPU and GPU miner for bitcoin.
+This is a multi-threaded multi-pool CPU and GPU miner for bitcoin.
 
 
 License: GPLv2.  See COPYING for details.
 License: GPLv2.  See COPYING for details.
 
 
@@ -66,6 +66,22 @@ Native WIN32 build instructions (on mingw32, on windows):
 
 
 Usage instructions:  Run "cgminer --help" to see options.
 Usage instructions:  Run "cgminer --help" to see options.
 
 
+
+EXECUTIVE SUMMARY ON USAGE:
+
+Single pool, regular desktop:
+
+cgminer -o http://pool:port -u username -p password
+
+Single pool, dedicated miner:
+
+cgminer -o http://pool:port -u username -p password -I 8
+
+Multiple pool, dedicated miner:
+
+cgminer -o http://pool1:port -u pool1username -p pool1password -o http://pool2:port -u pool2usernmae -p pool2password -I 8
+
+
 Also many issues and FAQs are covered in the forum thread
 Also many issues and FAQs are covered in the forum thread
 dedicated to this program,
 dedicated to this program,
 	http://forum.bitcoin.org/index.php?topic=28402.0
 	http://forum.bitcoin.org/index.php?topic=28402.0
@@ -100,4 +116,4 @@ I is current Intensity (changes in dynamic mode).
 NOTE: Running intensities above 9 with current hardware is likely to only
 NOTE: Running intensities above 9 with current hardware is likely to only
 diminish return performance even if the hash rate might appear better. A good
 diminish return performance even if the hash rate might appear better. A good
 starting baseline intensity to try on dedicated miners is 8. Higher values are
 starting baseline intensity to try on dedicated miners is 8. Higher values are
-there to cope with future improvements in hardware.
+there to cope with future improvements in hardware.