Merge pull request #3 from jbruggeman/master

doc: update faq and windows build docs

doc/FAQ

@@ -67,8 +67,8 @@ though.
 
 Q: I'm having an issue. What debugging information should I provide?
 A: Start sgminer with your regular commands and add -D -T --verbose and provide
-the full startup output and a summary of your hardware, operating system, ATI
+the full startup output and a summary of your hardware, operating system, AMD
-driver version and ATI stream version.
+driver version and AMD stream version.
 
 Q: Why don't you provide win64 builds?
 A: Win32 builds work everywhere and there is precisely zero advantage to a
@@ -85,12 +85,7 @@ A: sgminer will compile on OSX, but the performance of GPU mining is
 compromised due to the opencl implementation on OSX, there is no temperature
 or fanspeed monitoring, and the cooling design of most MACs, despite having
 powerful GPUs, will usually not cope with constant usage leading to a high
-risk of thermal damage. It is highly recommended not to mine on a MAC unless
+risk of thermal damage. It is highly recommended not to mine on a MAC.
-it is to a USB device.
-
-Q: I'm trying to mine litecoin but sgminer shows MH values instead of kH and
-submits no shares?
-A: Add the --scrypt parameter.
 
 Q: I switch users on windows and my mining stops working?
 A: That's correct, it does. It's a permissions issue that there is no known
@@ -116,19 +111,8 @@ it fail when php is installed properly but I only get errors about Sockets not
 working in the logs?
 A: http://us.php.net/manual/en/sockets.installation.php
 
-Q: What is a PGA?
-A: At the moment, sgminer supports 3 FPGAs: BitForce, Icarus and ModMiner.
-They are Field-Programmable Gate Arrays that have been programmed to do Bitcoin
-mining. Since the acronym needs to be only 3 characters, the "Field-" part has
-been skipped.
-
-Q: What is an ASIC?
-A: sgminer currently supports 2 ASICs: Avalon and BitForce SC devices. They
-are Application Specify Integrated Circuit devices and provide the highest
-performance per unit power due to being dedicated to only one purpose.
-
 Q: Can I mine scrypt with FPGAs or ASICs?
-A: No.
+A: As of Jan 15 2014, no.
 
 Q: What is stratum and how do I use it?
 A: Stratum is a protocol designed for pooled mining in such a way as to
@@ -162,13 +146,6 @@ Q: Can I make a donation in litecoin?
 A: Yes, see SCRYPT-README for the address, but the author prefers bitcoin if
 possible.
 
-Q: My keyboard input momentarily pauses or repeats keys every so often on
-windows while mining?
-A: The USB implementation on windows can be very flaky on some hardware and
-every time sgminer looks for new hardware to hotplug it it can cause these
-sorts of problems. You can disable hotplug with:
---hotplug 0
-
 Q: What should my Work Utility (WU) be?
 A: Work utility is the product of hashrate * luck and only stabilises over a
 very long period of time. Assuming all your work is valid work, bitcoin mining

doc/windows-build.txt

@@ -169,7 +169,7 @@ Extract the share\git-core folder and place it into \MinGW\share.
 After the previous step you should have a folder called \MinGW\share\git-core.
 To test if it is working, open a MinGW shell and type the following:
   git config -–global core.autocrlf false (note: one time run only)
-  git clone git://github.com/ckolivas/sgminer.git
+  git clone git://github.com/veox/sgminer.git
 
 If you simply just want to update the source after you have already cloned, type:
   git pull
@@ -191,65 +191,13 @@ From now on when your current working directory is the sgminer source directory
 You can simply type "adl.sh" and it will place the ADL header files into place
 For you. Make sure you never remove the ADL_SDK folder from your home folder.
 
-**************************************************************************************
-* Optional - Install libusb if you need auto USB device detection; required for Ztex *
-**************************************************************************************
-Go to this url ==> http://git.libusb.org/?p=libusb.git;a=snapshot;h=master;sf=zip
-save the file to your local storage. Open the file and copy the libusb* folder to
-\MinGW\msys\1.0\home\(your user directory/folder).
-Or if you do not want to download the file directly and would like to use git then
-Type the following from the MSYS shell in your home folder.
-git clone git://git.libusb.org/libusb.git
-
-Run the MinGW MSYS shell
-(Start Icon/keyboard key ==> All Programs ==> MinGW ==> MinGW Shell).
-Change the working directory to your libusb project folder.
-Example: cd libusb-something [Enter Key] if you are unsure then type "ls -la"
-Another way is to type "cd libusb" and then press the tab key; It will auto fill.
-Type the lines below one at a time. Look for problems after each one before going on
-to the next.
-
-./autogen.sh --disable-debug-log --prefix=/MinGW
-make
-make install
-
-You may now exit the MSYS shell.
-Ctrl-D or typing "logout" and pressing the enter key should get you out of the
-window.
-
-You will have to copy "libusb-1.0.dll" to your working sgminer binary directory.
-You will find "libusb-1.0.dll" in the \MinGW\bin directory/folder.
-
-Use this method if libusb does not work for you on Ztex. Once someone lets us know
-Libusb works instead of libusbx then we will remove the section below this line.
-Run the MSYS shell and change into the libusb folder as above.
-Type ==> make uninstall
-Go to this url ==> http://libusbx.org/
-Click on the "Downloads" tab.
-Click on "releases".
-Click on the latest version. I downloaded 1.0.14; yours may be newer.
-Do not download from the link that says "Looking for the latest version?".
-Click on "Windows"
-Click on the file and download it. I downloaded libusbx-1.0.12-win.7z.
-Extract the the following from the file and place in where directed.
-Copy libusb.h from include\libusbx-1.0 to \MinGW\include\libusb-1.0\libusb.h
-Copy contents of MinGW32\static \MinGW\lib
-Copy contents of MinGW32\dll to \MinGW\lib
-You will have to copy "libusb-1.0.dll" to your working sgminer binary directory.
-
 **************************************************************************************
 * Some ./configure options                                                           *
 **************************************************************************************
---enable-cpumining      Build with cpu mining support(default disabled)
+--enable-opencl         Enable support for GPU mining with opencl
---disable-opencl        Override detection and disable building with opencl
 --disable-adl           Override detection and disable building with adl
---enable-bitforce       Compile support for BitForce FPGAs(default disabled)
+--disable-libcurl       Disable building with libcurl for getwork and GBT support
---enable-icarus         Compile support for Icarus Board(default disabled)
---enable-modminer       Compile support for ModMiner FPGAs(default disabled)
---enable-ztex           Compile support for Ztex Board(default disabled)
---enable-scrypt         Compile support for scrypt litecoin mining (default disabled)
 --without-curses        Compile support for curses TUI (default enabled)
---without-libudev       Autodetect FPGAs using libudev (default enabled)
 
 ######################################################################################
 #                                                                                    #