X-Git-Url: http://developer.intra2net.com/git/?p=libftdi;a=blobdiff_plain;f=README;h=c64f8843f6c4df4bd0fd74f9910bc6349121f343;hp=7511e63613475fa1eb42a9082d556814235c8d5e;hb=11a50ae5b80b3e03694a19e84513345d0794e563;hpb=e5b85a083f6b06290e91cbc71cbf89d8e36e82d0

diff --git a/README b/README
index 7511e63..c64f884 100644
--- a/README
+++ b/README
@@ -1,40 +1,67 @@
 --------------------------------------------------------------------
-libftdi version 0.17
+libftdi version 1.5
 --------------------------------------------------------------------
 
 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.
 
-Many thanks to Marek Vavruša for providing
-the initial C++ wrapper implementation.
-
 Changes
 -------
-* C++ wrapper: Reopen the device after calling get_strings() in Context::open() (Marek Vavruša and Intra2net)
-* C++ wrapper: Fixed an inheritance problem (Marek Vavruša and Intra2net)
-* C++ wrapper: Relicensed under GPLv2 + linking exception (Marek Vavruša and Intra2net)
-* Support for FT2232H and FT4232H (David Challis, Alex Harford and Intra2net)
-* Support for mingw cross compile (Uwe Bonnes)
-* Python bindings and minor autoconf cleanup (Tarek Heiland)
-* Code cleanup in various places (Intra2net)
-* Fixed ftdi_read_chipid in some cases (Matthias Richter)
-* eeprom decode function and small cleanups (Marius Kintel)
-* cmake system improvements (Marius Kintel and Intra2net)
-* Fix compilation in -ansi -pedantic mode (Matthias Janke)
+* Implement tc[io]flush methods & deprecate broken purge_buffers methods
+
+  Please check your code for ftdi_usb_purge_rx_buffer(),
+  ftdi_usb_purge_tx_buffer() and ftdi_usb_purge_buffers()
+  and migrate to the new ftdi_tc[io]flush() methods.
+
+  Old code will continue to function, but you'll get
+  a deprecation warning during compilation.
+
+* Add program to test buffer flush (purge) functionality
+* Add kernel driver auto attach/detach.
+  See new AUTO_DETACH_REATACH_SIO_MODULE option
+* Add ftdi_setflowctrl_xonxoff()
+* ftdi_eeprom / eeprom handling:
+  * Unify handling of all boolean eeprom flags
+  * Add device release number support
+  * Add channel_a_driver support for type xxR chips
+  * Add support for group0 drive levels on x232H chips
+  * Fix handling of high_current_drive parameter
+  * Fix inverted handling of VCP driver field for TYPE_R chips
+  * New --verbose option for eeprom decode operation
+* Add example code for async mode
+* Add SPDX license identifiers to the core library & ftdi_eeprom
+* Various python SWIG wrapper improvements
+* Various cmake file improvements
+* Fix small bugs in error code paths
 
 You'll find the newest version of libftdi at:
-http://www.intra2net.com/en/developer/libftdi
+https://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-2009 Intra2net AG
+www.intra2net.com                             2003-2020 Intra2net AG
 --------------------------------------------------------------------