]> sigrok.org Git - libserialport.git/blobdiff - README
Move special case for poll() timeout to call site.
[libserialport.git] / README
diff --git a/README b/README
index 4e2ba26e9f6f2fda88bd0e63d334930902e2732c..f63be5cdb2161415bddc402d9e5c54e95ff097bf 100644 (file)
--- a/README
+++ b/README
@@ -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.
@@ -43,7 +43,7 @@ Building
 The package uses a GNU style build system and requires a Unix style shell.
 
 Windows builds can be created natively with the MinGW-w64 toolchain and
-MSYS environment, or cross-compiled using a MinGW-w64 toolchain:
+MSYS2 environment, or cross-compiled using a MinGW-w64 toolchain:
 
   http://mingw-w64.sourceforge.net/
 
@@ -56,3 +56,28 @@ API
 ===
 
 Doxygen API documentation is included.
+
+It can also be viewed online at:
+
+  http://sigrok.org/api/libserialport/unstable/
+
+Bug reports
+===========
+
+You can report bugs for libserialport at https://sigrok.org/bugzilla.
+
+Mailing list
+============
+
+ https://lists.sourceforge.net/lists/listinfo/sigrok-devel
+
+IRC
+===
+
+You can find the developers in the #sigrok IRC channel on Freenode.
+
+Website
+=======
+
+http://sigrok.org/wiki/Libserialport
+