change type of result variables to ssize_t

[libserialport.git] / README

diff --git a/README b/README
index dbfbc08a0709d965810b4d5b7392c1a11c14f9ac..817dff743df4ae7ae07f37eea955e0d0a8853f4b 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.
@@ -40,23 +40,51 @@ No other libraries are required.
 Building
 ========
 
-The package uses a GNU style build system and requires a Unix style shell.
+On Windows, libserialport can be built with Visual Studio 2019 or with
+the standalone MSBuild tool, using the solution and project files provided.
 
-Windows builds can be created natively with the MinGW-w64 toolchain and
-MSYS environment, or cross-compiled using a MinGW-w64 toolchain:
-
-  http://mingw-w64.sourceforge.net/
-
-The "old" MinGW from http://mingw.org/ is not supported.
+For other environments, the package uses a GNU style build based on autotools.
 
 Run "./autogen.sh" to generate the build system, "./configure" to setup, then
 "make" to build the library and "make install" to install it.
 
+Windows builds can also be created using the autotools build system, using the
+MinGW-w64 toolchain from http://mingw-w64.sourceforge.net/ - either natively
+in Windows with the MSYS2 environment, or cross-compiling from another system.
+
+To build from MSYS2, the following packages must be installed: autoconf,
+automake-wrapper, libtool, make, and either mingw-w64-i686-gcc (for 32-bit)
+or mingw-w64-x86_64-gcc (for 64-bit). Open either the "MSYS2 MinGW 32-bit" or
+"MSYS2 MinGW 64-bit" command window from the Start menu and use this when
+configuring and building the package. Using the "MSYS2 MSYS" shell will build
+against the Cygwin compatibility layer; this works, but port enumeration and
+metadata will not be available, and binaries will depend on Cygwin. The builds
+produced by MinGW-w64 are normal Windows DLLs without additional dependencies.
+
 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 Libera.Chat.
+
 Website
 =======