X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=README;h=4233db4d7f6c3f16dc9da2b43351d8707ee3692c;hb=28981e079352923629def80af29437261911c586;hp=4e2ba26e9f6f2fda88bd0e63d334930902e2732c;hpb=a46ee5b4d79311fe304c59ce115ebf3b725a295c;p=libserialport.git diff --git a/README b/README index 4e2ba26..4233db4 100644 --- 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,19 +40,46 @@ 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 +======= + +http://sigrok.org/wiki/Libserialport +