Skip to content

Commit

Permalink
Merge pull request 3cky#50 from nickma82/extending_readme
Browse files Browse the repository at this point in the history
added informaiton from a ticket question and dev information
  • Loading branch information
3cky committed May 27, 2019
2 parents ba41aae + 82b286d commit d33d66f
Showing 1 changed file with 24 additions and 5 deletions.
29 changes: 24 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ About mbusd

[![Build Status](https://travis-ci.org/3cky/mbusd.svg?branch=master)](https://travis-ci.org/3cky/mbusd)

**mbusd** is open-source [Modbus TCP to Modbus RTU (RS-232/485)](https://en.wikipedia.org/wiki/Modbus) gateway.
**mbusd** is open-source [Modbus TCP to Modbus RTU (RS-232/485)](https://en.wikipedia.org/wiki/Modbus)
gateway. It presents a network of RTU slaves as single TCP slave.

That is a TCP-Slave (or server) which acts as a RTU-master to get data from Modbus RTU-slave devices.

Features:
---------
Expand Down Expand Up @@ -128,8 +131,10 @@ To start the **mbusd** service on system boot:

Please check systemd documentation for other usefull systemd [commands](https://wiki.archlinux.org/index.php/systemd)

Reporting bugs:
---------------
Contributing:
-------------

### Reporting bugs

Please file [issue](https://github.com/3cky/mbusd/issues) with attached debug log in verbose (`-v9`) mode, i.e.:

Expand All @@ -138,8 +143,7 @@ Please file [issue](https://github.com/3cky/mbusd/issues) with attached debug lo
Unless you were prompted so or there is another pertinent reason (e.g. GitHub fails to accept the bug report),
please do not send bug reports via personal email.

Contributing:
-------------
### Workflow for code contributions

1. Fork it and clone forked repository
2. Create your feature branch (`git checkout -b my-new-feature`)
Expand All @@ -148,6 +152,21 @@ Contributing:
5. Push to the branch (`git push origin my-new-feature`)
6. Create new Pull Request

### Building and Testing

Dependencies: please see the correct OS-distribution section in the
[.gitlab-ci.yml](https://github.com/3cky/mbusd/blob/master/.gitlab-ci.yml)

With all dependencies met, one is able to *build and execute tests*
issuing the following *bash* commands:
```
# build
mkdir output.dir/ && cd $_
cmake ../ && make
# execute all tests
(cd ../ && python tests/run_itests.py output.dir/mbusd)
```

Author:
-------

Expand Down

0 comments on commit d33d66f

Please sign in to comment.