diff --git a/README.rst b/README.md index 08ae0a1..fe06873 100644 --- a/README.rst +++ b/README.md @@ -1,6 +1,5 @@ -========================= - A groovy modbus library -========================= +A groovy modbus library +======================= Overview -------- @@ -11,15 +10,15 @@ serial port or an Ethernet connection. The functions included in the library have been derived from the Modicon Modbus Protocol Reference Guide which can be obtained from -Schneider at www.schneiderautomation.com. +Schneider at [www.schneiderautomation.com](http://www.schneiderautomation.com). The license of libmodbus is LGPL v2.1 or later and the licence of programs in tests directory is GPL v3. The documentation is available under the Creative Commons Attribution-ShareAlike -License 3.0 (Unported) (http://creativecommons.org/licenses/by-sa/3.0/). +License 3.0 (Unported) (). -The official website is http://www.libmodbus.org. +The official website is [www.libmodbus.org](http://www.libmodbus.org). The library is written in C and designed to run on Linux, Mac OS X, FreeBSD and QNX and Windows. @@ -27,27 +26,27 @@ QNX and Windows. Installation ------------ -To instal, just run the usual dance, ``./configure && make install`` and run -``./autogen.sh`` first if the ``configure.sh`` is not present. +To instal, just run the usual dance, `./configure && make install` and run +`./autogen.sh` first if the `configure.sh` is not present. If you want to compile with Microsoft Visual Studio, you need to install -http://code.google.com/p/msinttypes/ to fill the absence of stdint.h. + to fill the absence of stdint.h. -To compile under Windows, install `MinGW `_ and MSYS then +To compile under Windows, install [MinGW](http://www.mingw.org/) and MSYS then select the common packages (gcc, automake, libtool, etc). Testing ------- -Some tests are provided in the ``tests`` directory, you can -freely edit the source code to fit your needs (it's Free Sofware :). +Some tests are provided in the `tests` directory, you can 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: - * fill a bug report on the issue tracker - http://github.com/stephane/libmodbus/issues - * or send an email to stephane.raimbault@gmail.com + +* fill a bug report on the issue tracker +* or send an email to stephane.raimbault@gmail.com