Commit 698a587d78ed0f88d9b9233dd4407ba01119544c
1 parent
ce82bb8c
Updated README
Showing
1 changed file
with
23 additions
and
14 deletions
README
| 1 | -================== | |
| 2 | -A groovy libmodbus | |
| 3 | -================== | |
| 1 | +======================== | |
| 2 | + A groovy modbus library | |
| 3 | +======================== | |
| 4 | 4 | |
| 5 | 5 | Overview |
| 6 | -======== | |
| 6 | +-------- | |
| 7 | 7 | |
| 8 | 8 | libmodbus is a free software library to send/receive data with a |
| 9 | 9 | device which respects the Modbus protocol. This library can use a |
| ... | ... | @@ -13,22 +13,31 @@ The functions included in the library have been derived from the |
| 13 | 13 | Modicon Modbus Protocol Reference Guide which can be obtained from |
| 14 | 14 | Schneider at www.schneiderautomation.com. |
| 15 | 15 | |
| 16 | -The license of libmodbus is LGPL v3. | |
| 17 | -The licence of programs in the tests directory is GPL v3. | |
| 16 | +The license of libmodbus is LGPL v3 and the licence of programs in tests | |
| 17 | +directory is GPL v3. | |
| 18 | 18 | |
| 19 | -http://github.com/stephane/libmodbus | |
| 20 | -(the old project page was https://launchpad.net/libmodbus) | |
| 21 | -http://copyleft.free.fr/wordpress/index.php/libmodbus/ | |
| 19 | +The official website is http://www.libmodbus.org. | |
| 20 | + | |
| 21 | +The library is written in C and designed to run on Linux, Mac OS X, FreeBSD and | |
| 22 | +QNX (UNIX-like OS). | |
| 22 | 23 | |
| 23 | 24 | Installation |
| 24 | -============ | |
| 25 | +------------ | |
| 25 | 26 | |
| 26 | -The shell commands are './configure; make; make install'. | |
| 27 | +The shell commands are ``./autogen.sh; ./configure; make; make install``. | |
| 27 | 28 | |
| 28 | 29 | Testing |
| 29 | -======= | |
| 30 | +------- | |
| 30 | 31 | |
| 31 | -Some testing programs are provided in the tests directory, you can | |
| 32 | +Some tests are provided in the ``tests`` directory, you can | |
| 32 | 33 | freely edit the source code to fit your needs (it's Free Sofware :). |
| 33 | 34 | |
| 34 | -See tests/README for a description of each program. | |
| 35 | +See ``tests/README`` for a description of each program. | |
| 36 | + | |
| 37 | +Report a Bug | |
| 38 | +------------ | |
| 39 | + | |
| 40 | +To report a bug, you can: | |
| 41 | + * send an email to stephane.raimbault@gmail.com | |
| 42 | + * or fill a bug report on the issue tracker | |
| 43 | + http://github.com/stephane/libmodbus/issues | ... | ... |