From 41d41b7deb416167da5a0de2638ecea078c13ea6 Mon Sep 17 00:00:00 2001
From: "Frust, Tobias (FWCC) - 111645" <t.frust@hzdr.de>
Date: Fri, 3 Nov 2017 09:03:18 +0100
Subject: add usage instructions

---
 README.md           | 35 +++++++++++++++++++++++++++++++++++
 src/main_client.cpp |  2 +-
 2 files changed, 36 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 416e55b..872f3c0 100644
--- a/README.md
+++ b/README.md
@@ -31,3 +31,38 @@ This little tool will simulate the online capabilities of the new detector. Ther
   `$ make`
 
 5. In the `bin` directory there will be two executables (`onlineDetectorSimulatorClient`, `onlineDetectorSimulatorServer`).
+
+## Usage
+
+The executable `onlineDetectorSimulatorClient` sends the UDP packages and `onlineDetectorSimulatorServer` receives them.
+
+The usage of the program will be shown using `localhost`:
+
+1. Copy the file `config.cfg` into the binary directory of your executables and make sure you have test data around.
+2. Start `onlineDetectorSimulatorServer`:
+
+  ```bash
+  $ ./onlineDetectorSimulatorServer <address>
+  ```
+
+  In case of localhost it would be:
+
+  ```bash
+  $ ./onlineDetectorSimulatorServer localhost
+  ```
+
+3. Start `onlineDetectorSimulatorClient`:
+
+  ```bash
+  $ ./onlineDetectorSimulatorClient <packets_per_second> <address>
+  ```
+
+  Take into account, that currently `packets_per_secon`d value is not equal to the images per second sent out. If you reduce the packet size in `config.cfg` you need to increase the `packets_per_second` value by the same factor to keep the same images per second rate.
+
+  ```bash
+  $ ./onlineDetectorSimulatorClient 1000 localhost
+  ```
+
+  The above command using the standard configuration in the repository sends  approximately 1000 images per second via UDP.
+
+  After some time, quit the client program using `ctrl+c`. The server program will stop after a timeout of `10 s`
\ No newline at end of file
diff --git a/src/main_client.cpp b/src/main_client.cpp
index 38c065d..01b3aad 100644
--- a/src/main_client.cpp
+++ b/src/main_client.cpp
@@ -20,7 +20,7 @@ void initLog() {
 int main (int argc, char *argv[]){
 
   if(argc < 3){
-     BOOST_LOG_TRIVIAL(error) << "Program usage: ./onlineDetectorSimulatorClient <images_per_second> <address>!";
+     BOOST_LOG_TRIVIAL(error) << "Program usage: ./onlineDetectorSimulatorClient <packets_per_second> <address>!";
      return 0;
   }
 
-- 
cgit v1.2.1