]> sigrok.org Git - libserialport.git/blobdiff - README
windows: Always check return value of GetOverlappedResult().
[libserialport.git] / README
diff --git a/README b/README
index 36c289d4d3e3c72f83e5de84727008d2fefbcb72..fe3237cd25037e9758d97c86b00a5682d6b69675 100644 (file)
--- a/README
+++ b/README
@@ -11,7 +11,7 @@ transparently on any platform supported by the library.
 The operations that are supported are:
 
 - Port enumeration (obtaining a list of serial ports on the system).
-- Obtaining port metadata (USB VID:PID, manufacturer and product name, etc).
+- Obtaining port metadata (USB device information, Bluetooth address, etc).
 - Opening and closing ports.
 - Setting port parameters (baud rate, parity, etc).
 - Reading, writing and flushing data.
@@ -25,9 +25,9 @@ Status
 The library should build and work on any Windows or Unix-based system. If it
 does not, please submit a bug.
 
-Enumeration is currently only implemented on Windows, Mac OS X and Linux. On
-other systems enumeration is not supported, but ports can still be opened by
-name and then used.
+Enumeration is currently implemented on Windows, Mac OS X, FreeBSD and Linux.
+On other systems enumeration is not supported, but ports can still be opened
+by name and then used.
 
 If you know how to enumerate available ports on another OS, please submit a bug
 with this information, or better still a patch implementing it.
@@ -41,7 +41,13 @@ Building
 ========
 
 The package uses a GNU style build system and requires a Unix style shell.
-On Windows it can be built with the MinGW toolchain and MSYS environment.
+
+Windows builds can be created natively with the MinGW-w64 toolchain and
+MSYS2 environment, or cross-compiled using a MinGW-w64 toolchain:
+
+  http://mingw-w64.sourceforge.net/
+
+The "old" MinGW from http://mingw.org/ is not supported.
 
 Run "./autogen.sh" to generate the build system, "./configure" to setup, then
 "make" to build the library and "make install" to install it.
@@ -50,3 +56,13 @@ API
 ===
 
 Doxygen API documentation is included.
+
+It can also be viewed online at:
+
+  http://sigrok.org/api/libserialport/unstable/
+
+Website
+=======
+
+http://sigrok.org/wiki/Libserialport
+