Fix building on Cygwin.

[libserialport.git] / README

diff --git a/README b/README
index a0f5f31d1d11f8309f349155f522c57c5667307b..840a6962c7283a1404ba63cfac6c6eeb26cd8b4c 100644 (file)
--- a/README
+++ b/README
@@ -40,18 +40,26 @@ 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
-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.
+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. The "MSYS2 MSYS" shell will not work.
+
+The "old" MinGW from http://mingw.org/ is not supported.
+
 API
 ===
 
@@ -61,6 +69,11 @@ 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
 ============