From 0fb68aefa3e7ccb46072892dc48a11736a44986c Mon Sep 17 00:00:00 2001 From: Stéphane Raimbault Date: Mon, 12 Nov 2012 23:50:01 +0100 Subject: [PATCH] Switch README from ReST to Markdown --- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.rst | 53 ----------------------------------------------------- 2 files changed, 52 insertions(+), 53 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/README.md b/README.md new file mode 100644 index 0000000..fe06873 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +A groovy modbus library +======================= + +Overview +-------- + +libmodbus is a free software library to send/receive data with a +device which respects the Modbus protocol. This library can use a +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](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) (). + +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. + +Installation +------------ + +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 + to fill the absence of stdint.h. + +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 :). + +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 +* or send an email to stephane.raimbault@gmail.com diff --git a/README.rst b/README.rst deleted file mode 100644 index 08ae0a1..0000000 --- a/README.rst +++ /dev/null @@ -1,53 +0,0 @@ -========================= - A groovy modbus library -========================= - -Overview --------- - -libmodbus is a free software library to send/receive data with a -device which respects the Modbus protocol. This library can use a -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. - -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/). - -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 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. - -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 compile under Windows, install `MinGW `_ 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 :). - -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 -- libgit2 0.21.4