README* refactoring

This is an attempt to bring the README files in line with the current
status of the OpenOCD development.

- remove some obsolete information and duplicated instructions
- reword some statements
- restructure in a way more appealing to a regular user
- add a supported hardware list to allow a potential user to determine
  if his/her usecase is covered by a freetext keyword search through
  the document
- Add OSX notes (courtesy GrizzlyAdams and inca)

Since most ftdi-based adapters are now covered by the ftdi driver, I
think it's ok to remove some of the libftdi/ftd2xx instructions, the
few users who still need them should refer to upstream docs instead.

I'm not sure if README.Windows should come with the DOS line endings,
but i'd expect many windows users to use their silly notepad to view
it, and notepad ignores LF apparently. (Decided to use LF anyway.)

I understand discussing and reviewing such a massive README change is
a somewhat demanding task but I feel it's a necessity to move forward
maintaining proper documentation.

Change-Id: Idfde3014c72dd5c32ad292ee1ab205322e51a138
Signed-off-by: Paul Fertser <fercerpav@gmail.com>
Signed-off-by: Andreas Fritiofson <andreas.fritiofson@gmail.com>
Reviewed-on: http://openocd.zylin.com/1503
Tested-by: jenkins
Reviewed-by: Xiaofan <xiaofanc@gmail.com>

1 files changed, 28 insertions, 0 deletions

diff --git a/README.OSX b/README.OSX
new file mode 100644
index 0000000..5fec44f
--- /dev/null
+++ b/README.OSX
@@ -0,0 +1,28 @@
+Building OpenOCD for OSX
+------------------------
+
+There are a few prerequisites you will need first:
+
+- Xcode 4 (install from the AppStore)
+- Command Line Tools (install from Xcode 4 -> Preferences -> Downloads)
+- MacPorts (http://www.macports.org/install.php)
+  or
+- Homebrew (http://mxcl.github.io/homebrew/)
+
+libtool, automake, autoconf and libusb can be easily installed via
+MacPorts:
+  sudo port install libtool automake autoconf libusb [libusb-compat]
+or with Homebrew:
+  brew install libtool automake libusb [libusb-compat]
+
+You should also specify LDFLAGS and CPPFLAGS to allow configure to use
+MacPorts' libraries, so run configure like this:
+  LDFLAGS=-L/opt/local/lib CPPFLAGS=-I/opt/local/include ./configure [options]
+
+If you're using Homebrew, no custom flags are necessary.
+
+See README for the generic building instructions.
+
+If you use an FTDI-based adapter and have the FTDI kext installed, you
+will need to unload it prior to using OpenOCD:
+  sudo kextunload FTDIUSBSerialDriver.kext