Fix a potential segfault in sp_get_port_handle().

[libserialport.git] / README

diff --git a/README b/README
index 35b32434c34149a672870f17015304f039317f25..fe3237cd25037e9758d97c86b00a5682d6b69675 100644 (file)
--- a/README
+++ b/README
@@ -11,6 +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 device information, Bluetooth address, etc).
 - Opening and closing ports.
 - Setting port parameters (baud rate, parity, etc).
 - Reading, writing and flushing data.
@@ -24,33 +25,29 @@ 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 will return no results, but ports can still be opened
+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.
 
-Future
-======
-
-Future versions will add additional API calls for obtaining metadata about a
-port, e.g. for USB devices the USB VID and PID of the underlying device.
-
 Dependencies
 ============
 
-On Linux, libudev is required. On other systems no other libraries are required.
-
-The libudev dependency could be eliminated in favour of direct sysfs queries at
-the cost of some brevity. This is not currently a priority but if you feel like
-doing this feel free to submit a patch.
+No other libraries are required.
 
 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.
@@ -59,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
+