X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=README;h=7666a5c144fe199d862410cfe4f6696d4d2eba68;hb=da8730199a215c9ccd938202fb55ac9e3f58a0b2;hp=e69de29bb2d1d6434b8b29ae775ad8c2e48c5391;hpb=0662f2bb88079a49ed6329e960aa57dabec5ba34;p=libserialport.git

diff --git a/README b/README
index e69de29..7666a5c 100644
--- a/README
+++ b/README
@@ -0,0 +1,52 @@
+-------------------------------------------------------------------------------
+libserialport: cross-platform library for accessing serial ports
+-------------------------------------------------------------------------------
+
+libserialport is a minimal library written in C that is intended to take care
+of the OS-specific details when writing software that uses serial ports.
+
+By writing your serial code to use libserialport, you enable it to work
+transparently on any platform supported by the library.
+
+The operations that are supported are:
+
+- Port enumeration (obtaining a list of serial ports on the system).
+- Obtaining port metadata (USB device information, Bluetooth address, etc).
+- Opening and closing ports.
+- Setting port parameters (baud rate, parity, etc).
+- Reading, writing and flushing data.
+- Obtaining error information.
+
+libserialport is an open source project released under the LGPL3+ license.
+
+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.
+
+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.
+
+Dependencies
+============
+
+No other libraries are required.
+
+Building
+========
+
+The package uses a GNU style build system and requires a Unix style shell.
+On Windows it can be built with the MinGW toolchain and MSYS environment.
+
+Run "./autogen.sh" to generate the build system, "./configure" to setup, then
+"make" to build the library and "make install" to install it.
+
+API
+===
+
+Doxygen API documentation is included.