Bump release to v3.0.8
[libmodbus.git] / README.rst
blobdb9e01699d58c69c130fd9a87b9c6cf98f80cb12
1 =========================
2  A groovy modbus library
3 =========================
5 Overview
6 --------
8 libmodbus is a free software library to send/receive data with a
9 device which respects the Modbus protocol. This library can use a
10 serial port or an Ethernet connection.
12 The functions included in the library have been derived from the
13 Modicon Modbus Protocol Reference Guide which can be obtained from
14 Schneider at www.schneiderautomation.com.
16 The license of libmodbus is LGPL v2.1 or later and the licence of programs in
17 tests directory is GPL v3.
19 The documentation is available under the Creative Commons Attribution-ShareAlike
20 License 3.0 (Unported) (http://creativecommons.org/licenses/by-sa/3.0/).
22 The official website is http://www.libmodbus.org.
24 The library is written in C and designed to run on Linux, Mac OS X, FreeBSD and
25 QNX and Windows.
27 Installation
28 ------------
30 The shell commands are ``./autogen.sh; ./configure; make; make install``.
32 If you want to compile with Microsoft Visual Studio, you need to install
33 http://code.google.com/p/msinttypes/ to fill the absence of stdint.h.
35 Testing
36 -------
38 Some tests are provided in the ``tests`` directory, you can
39 freely edit the source code to fit your needs (it's Free Sofware :).
41 See ``tests/README`` for a description of each program.
43 Report a Bug
44 ------------
46 To report a bug, you can:
47  * fill a bug report on the issue tracker
48    http://github.com/stephane/libmodbus/issues
49  * or send an email to stephane.raimbault@gmail.com