Commit 0fb68aefa3e7ccb46072892dc48a11736a44986c
1 parent
0468c30b
Switch README from ReST to Markdown
Showing
1 changed file
with
15 additions
and
16 deletions
README.rst renamed to README.md
| 1 | -========================= | |
| 2 | - A groovy modbus library | |
| 3 | -========================= | |
| 1 | +A groovy modbus library | |
| 2 | +======================= | |
| 4 | 3 | |
| 5 | 4 | Overview |
| 6 | 5 | -------- |
| ... | ... | @@ -11,15 +10,15 @@ serial port or an Ethernet connection. |
| 11 | 10 | |
| 12 | 11 | The functions included in the library have been derived from the |
| 13 | 12 | Modicon Modbus Protocol Reference Guide which can be obtained from |
| 14 | -Schneider at www.schneiderautomation.com. | |
| 13 | +Schneider at [www.schneiderautomation.com](http://www.schneiderautomation.com). | |
| 15 | 14 | |
| 16 | 15 | The license of libmodbus is LGPL v2.1 or later and the licence of programs in |
| 17 | 16 | tests directory is GPL v3. |
| 18 | 17 | |
| 19 | 18 | The documentation is available under the Creative Commons Attribution-ShareAlike |
| 20 | -License 3.0 (Unported) (http://creativecommons.org/licenses/by-sa/3.0/). | |
| 19 | +License 3.0 (Unported) (<http://creativecommons.org/licenses/by-sa/3.0/>). | |
| 21 | 20 | |
| 22 | -The official website is http://www.libmodbus.org. | |
| 21 | +The official website is [www.libmodbus.org](http://www.libmodbus.org). | |
| 23 | 22 | |
| 24 | 23 | The library is written in C and designed to run on Linux, Mac OS X, FreeBSD and |
| 25 | 24 | QNX and Windows. |
| ... | ... | @@ -27,27 +26,27 @@ QNX and Windows. |
| 27 | 26 | Installation |
| 28 | 27 | ------------ |
| 29 | 28 | |
| 30 | -To instal, just run the usual dance, ``./configure && make install`` and run | |
| 31 | -``./autogen.sh`` first if the ``configure.sh`` is not present. | |
| 29 | +To instal, just run the usual dance, `./configure && make install` and run | |
| 30 | +`./autogen.sh` first if the `configure.sh` is not present. | |
| 32 | 31 | |
| 33 | 32 | If you want to compile with Microsoft Visual Studio, you need to install |
| 34 | -http://code.google.com/p/msinttypes/ to fill the absence of stdint.h. | |
| 33 | +<http://code.google.com/p/msinttypes/> to fill the absence of stdint.h. | |
| 35 | 34 | |
| 36 | -To compile under Windows, install `MinGW <http://www.mingw.org/>`_ and MSYS then | |
| 35 | +To compile under Windows, install [MinGW](http://www.mingw.org/) and MSYS then | |
| 37 | 36 | select the common packages (gcc, automake, libtool, etc). |
| 38 | 37 | |
| 39 | 38 | Testing |
| 40 | 39 | ------- |
| 41 | 40 | |
| 42 | -Some tests are provided in the ``tests`` directory, you can | |
| 43 | -freely edit the source code to fit your needs (it's Free Sofware :). | |
| 41 | +Some tests are provided in the `tests` directory, you can freely edit the source | |
| 42 | +code to fit your needs (it's Free Sofware :). | |
| 44 | 43 | |
| 45 | -See ``tests/README`` for a description of each program. | |
| 44 | +See *tests/README* for a description of each program. | |
| 46 | 45 | |
| 47 | 46 | Report a Bug |
| 48 | 47 | ------------ |
| 49 | 48 | |
| 50 | 49 | To report a bug, you can: |
| 51 | - * fill a bug report on the issue tracker | |
| 52 | - http://github.com/stephane/libmodbus/issues | |
| 53 | - * or send an email to stephane.raimbault@gmail.com | |
| 50 | + | |
| 51 | +* fill a bug report on the issue tracker <http://github.com/stephane/libmodbus/issues> | |
| 52 | +* or send an email to stephane.raimbault@gmail.com | ... | ... |