Create readme for the project

1 files changed, 44 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8318210
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# Midbro – Packet Capturing for the PASAD IDS
+
+Created by Robert Gustafsson, Robin Krahl and Andreas Lindhé in DAT300 2017 at
+Chalmers University of Technology. Copyright belongs to the authors.
+
+## Dependencies
+
+These dependencies are packaged in the Debian repositories, but are also
+available on other platforms.
+
+* Bro (`bro`)
+* Broccoli (`libbroccoli-dev`)
+* Tcpreplay (`tcpreplay`)
+
+## Workflow
+
+0. Compile and export library path
+1. Start Bro
+2. Start the consumer (PASAD or midbro_test)
+3. Send network traffic
+
+
+## Example usage:
+
+The commands below assume you are in the root directory of this repository.
+
+### 0. Compile & export path
+
+`make && make midbro_test`
+`export export LD_LIBRARY_PATH=$(pwd)/lib`
+
+### 1. Start Bro
+
+`sudo bro -b -C -i lo script/modbus.bro Log::default_writer=Log::WRITER_NONE`
+
+### 2. Start the consumer
+
+**PASAD:** `cd data; ../bin/pasad 1000 500 18`
+
+**midbro_test:** `./bin/midbro_test`
+
+### 3. Send network traffic
+
+`sudo tcpreplay -i lo -M 100.0 livedata.cap`