]> sigrok.org Git - libserialport.git/blobdiff - README
Compile with -pedantic.
[libserialport.git] / README
diff --git a/README b/README
index 35b32434c34149a672870f17015304f039317f25..7666a5c144fe199d862410cfe4f6696d4d2eba68 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.
@@ -25,26 +26,16 @@ 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
-by name and then used.
+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
 ========