add build instructions

1 files changed, 31 insertions, 0 deletions

diff --git a/README.md b/README.md
index 064da90..416e55b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,33 @@
 # OnlineDetectorSimulator
 This little tool will simulate the online capabilities of the new detector. Therefore, a dataset has been created which offers the same structure as the data from the new detector. The software sends out the packages via UDP.
+
+## Build instructions
+
+1. Dependencies:
+
+  - Boost >= 1.58.0
+  - libconfig
+  - cmake
+  - A C++11 compiler like gcc
+
+  On debian-based systems install using the given commands:
+
+  `$ sudo apt-get install libboost-all-dev libconfig++-dev`
+
+2. Clone the repository:
+
+  `$ git clone git@github.com:HZDR-FWDF/OnlineDetectorSimulator.git && cd OnlineDetectorSimulator`
+
+3. Run cmake:
+
+  ```bash
+  # Create build directory
+  $ mkdir build && cd build
+  $ cmake -DCMAKE_BUILD_TYPE=Release ../src/.
+  ```
+
+4. Build the software
+
+  `$ make`
+
+5. In the `bin` directory there will be two executables (`onlineDetectorSimulatorClient`, `onlineDetectorSimulatorServer`).