diff --git a/tests/Makefile.am b/tests/Makefile.am index 184d3e6..38fa21c 100644 --- a/tests/Makefile.am +++ b/tests/Makefile.am @@ -1,4 +1,4 @@ -EXTRA_DIST = README unit-tests.sh +EXTRA_DIST = README.md unit-tests.sh noinst_PROGRAMS = \ bandwidth-server-one \ diff --git a/tests/README b/tests/README deleted file mode 100644 index 04d192b..0000000 --- a/tests/README +++ /dev/null @@ -1,42 +0,0 @@ -License -------- -Test programs of this directory are provided under BSD license (see associated -LICENSE file). - -Compilation ------------ -After installation, you can use pkg-config to compile these tests. -For example, to compile random-test-server run: - -gcc random-test-server.c -o random-test-server `pkg-config --libs --cflags libmodbus` - -random-test-server ------------------ -It's necessary to launch this server before run random-test-client. By -default, it receives and responses to Modbus query on the localhost -and port 1502. - -random-test-client ------------------- -This programm sends many different queries to a large range of -addresses and values to test the communication between the client and -the server. - -unit-test-server -unit-test-client ----------------- -By default, this program sends some queries with the values defined in -unit-test.h and checks the responses. These programs are useful to -test the protocol implementation. - -bandwidth-server-one -bandwidth-server-many-up -bandwidth-client ------------------------ -It returns some very useful informations about the performance of -transfert rate between the server and the client. - -- bandwidth-server-one: it can handles only one connection with a client. -- bandwidth-server-many-up: it opens a connection each time a new client asks - for, but the number of connection is limited. The same server process handles - all the connections. diff --git a/tests/README.md b/tests/README.md new file mode 100644 index 0000000..810dc8c --- /dev/null +++ b/tests/README.md @@ -0,0 +1,27 @@ +# License +Test programs of this directory are provided under BSD license (see associated +LICENSE file). + +# Compilation +After installation, you can use pkg-config to compile these tests. +For example, to compile random-test-server run: + +gcc random-test-server.c -o random-test-server `pkg-config --libs --cflags libmodbus` + +- `random-test-server` is necessary to launch a server before running +random-test-client. By default, it receives and replies to Modbus query on the +localhost and port 1502. + +- `random-test-client` sends many different queries to a large range of +addresses and values to test the communication between the client and the +server. + +- `unit-test-server` and `unit-test-client` run a full unit test suite. These +programs are essential to test the Modbus protocol implementation and libmodbus +behavior. + +- `bandwidth-server-one`, `bandwidth-server-many-up` and `bandwidth-client` + return very useful information about the performance of transfert rate between + the server and the client. `bandwidth-server-one` can only handles one + connection at once with a client whereas `bandwidth-server-many-up` opens a + connection for each new clients (with a limit).