Stéphane Raimbault 14 жил өмнө
parent
commit
698a587d78
1 өөрчлөгдсөн 23 нэмэгдсэн , 14 устгасан
  1. 23 14
      README

+ 23 - 14
README

@@ -1,9 +1,9 @@
-==================
-A groovy libmodbus
-==================
+========================
+ A groovy modbus library
+========================
 
 
 Overview
 Overview
-========
+--------
 
 
 libmodbus is a free software library to send/receive data with a
 libmodbus is a free software library to send/receive data with a
 device which respects the Modbus protocol. This library can use a
 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
 Modicon Modbus Protocol Reference Guide which can be obtained from
 Modicon Modbus Protocol Reference Guide which can be obtained from
 Schneider at www.schneiderautomation.com.
 Schneider at www.schneiderautomation.com.
 
 
-The license of libmodbus is LGPL v3.
-The licence of programs in the tests directory is GPL v3.
+The license of libmodbus is LGPL v3 and the licence of programs in tests
+directory is GPL v3.
 
 
-http://github.com/stephane/libmodbus
-(the old project page was https://launchpad.net/libmodbus)
-http://copyleft.free.fr/wordpress/index.php/libmodbus/
+The official website is http://www.libmodbus.org.
+
+The library is written in C and designed to run on Linux, Mac OS X, FreeBSD and
+QNX (UNIX-like OS).
 
 
 Installation
 Installation
-============
+------------
 
 
-The shell commands are './configure; make; make install'.
+The shell commands are ``./autogen.sh; ./configure; make; make install``.
 
 
 Testing
 Testing
-=======
+-------
 
 
-Some testing programs are provided in the tests directory, you can
+Some tests are provided in the ``tests`` directory, you can
 freely edit the source code to fit your needs (it's Free Sofware :).
 freely edit the source code to fit your needs (it's Free Sofware :).
 
 
-See tests/README for a description of each program.
+See ``tests/README`` for a description of each program.
+
+Report a Bug
+------------
+
+To report a bug, you can:
+ * send an email to stephane.raimbault@gmail.com
+ * or fill a bug report on the issue tracker
+   http://github.com/stephane/libmodbus/issues