Update changelog for 1.3, update AUTHORS

[libftdi] / README

diff --git a/README b/README
index e681fc8..4a5d45b 100644 (file)
--- a/README
+++ b/README
@@ -1,26 +1,61 @@
--------------------------------------------------------------------
-libftdi version 0.12
--------------------------------------------------------------------
+--------------------------------------------------------------------
+libftdi version 1.3
+--------------------------------------------------------------------
 
-libftdi - A library (using libusb) to talk to FTDI's FT2232C,
-FT232BM and FT245BM type chips including the popular bitbang mode.
+libftdi - A library (using libusb) to talk to FTDI's UART/FIFO chips
+including the popular bitbang mode.
+
+The following chips are supported:
+* FT230X
+- FT4232H / FT2232H
+- FT232R  / FT245R
+- FT2232L / FT2232D / FT2232C
+- FT232BM / FT245BM (and the BL/BQ variants)
+- FT8U232AM / FT8U245AM
+
+libftdi requires libusb 1.x.
 
 The AUTHORS file contains a list of all the people
 that made libftdi possible what it is today.
 
 Changes
 -------
-* Fix build of documentation for "out of tree" builds
-* Fix USB config descriptor in the eeprom (Juergen Beisert)
-* Ability to purge RX/TX buffers separately (Arnim Läuger)
-* Setting of event and error character (Arnim Läuger)
-* Poll modem status function (Arnim Läuger and Intra2net)
-* Updated documentation and created AUTHORS file
-
+* Added ftdi_usb_get_strings2() to prevent automatic device close (Fahrzin Hemmati)
+* Added ftdi_transfer_data_cancel() for cancellation of a submitted transfer,
+  avoided resubmittion of a canceled transfer in the callbacks,
+  replaced calls to libusb_handle_events with
+  libusb_handle_events_timeout_completed (Eugene Hutorny)
+* ftdi_eeprom / eeprom handling:
+  * Add support for arbitrary user data (Salvador Eduardo Tropea)
+  * Add --build-eeprom support (Salvador Eduardo Tropea)
+  * Fix use_usb_version config file option (Thilo Schulz)
+  * Ability to include other config files in EEPROM config file (Thilo Schulz)
+  * Add external oscillator enable bit (Raphael Assenat)
+  * Support channel configuration (Stephan Linz)
+  * Added --device option to ftdi_eeprom to specify FTDI device (Robin Haberkorn)
+  * Fixed EEPROM user-area space checks for FT232R and FT245R chips (Robin Haberkorn)
+* Various improvements to CBUS handling, including the EEPROM (Robin Haberkorn)
+* swig wrapper: Fix handling of binary strings in ftdi_write_data()
+  for python 3 (xantares09)
+* cbus python example code (Rodney Sinclair)
+* ftdi_stream: fix timeout setting (Ларионов Даниил)
+* Fixed typo in CBUS defines: CBUSG_DRIVE1 -> CBUSH_DRIVE1
 
 You'll find the newest version of libftdi at:
-http://www.intra2net.com/de/produkte/opensource/ftdi/
+http://www.intra2net.com/en/developer/libftdi
+
+
+Quick start
+-----------
+mkdir build
+cd build
+
+cmake -DCMAKE_INSTALL_PREFIX="/usr" ../
+make
+make install
+
+More verbose build instructions are in "README.build"
 
--------------------------------------------------------------------
-www.intra2net.com                            2003-2008 Intra2net AG
--------------------------------------------------------------------
+--------------------------------------------------------------------
+www.intra2net.com                             2003-2014 Intra2net AG
+--------------------------------------------------------------------