]> sigrok.org Git - libserialport.git/blobdiff - README
README: update build instructions with VS2019/MSBuild options.
[libserialport.git] / README
diff --git a/README b/README
index f3220abfb457fecb27c0012b84b7f48445fdc8fb..4233db4d7f6c3f16dc9da2b43351d8707ee3692c 100644 (file)
--- a/README
+++ b/README
@@ -40,23 +40,44 @@ 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.
+
+The "old" MinGW from http://mingw.org/ is not supported.
+
 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
 =======