Browse Source

Maintain READMEs

Jonas Pflanzer 4 years ago
parent
commit
e057cd4b1a
2 changed files with 49 additions and 35 deletions
  1. 0 35
      README.md
  2. 49 0
      daemon/README.md

+ 0 - 35
README.md

@@ -2,38 +2,3 @@
 
 Covert Channels are Tricky Stuff
 
-## daemon installation
-
-Change to daemon/ and run cmake and compile with
-
-```
-mkdir build
-cmake ..
-```
-and
-```
-make
-```
-
-Copy executable
-
-```
-sudo cp ccats /usr/bin
-```
-
-
-Copy service file
-
-```
-sudo cp ccats.service /etc/systemd/system/
-```
-
-Enable and start service with
-
-```
-sudo systemctl enable ccats.service
-```
-and
-```
-sudo systemctl start ccats.service
-```

+ 49 - 0
daemon/README.md

@@ -0,0 +1,49 @@
+# Daemon
+
+## Build
+```
+mkdir build
+cd build
+cmake ..
+make
+```
+
+### Tests
+To build tests just set the `ENABLE_TESTS` variable to true and rebuild the program.
+```
+cmake .. -DENABLE_TESTS=true
+make
+```
+
+## Run
+Currently the first argument is the network interface for the sniffer.
+```
+bin/ccats lo
+```
+
+### Tests
+```
+make test
+```
+
+## Installation
+
+After building the program copy executable:
+```
+sudo cp bin/ccats /usr/bin
+```
+
+
+Copy service file:
+```
+sudo cp ccats.service /etc/systemd/system/
+```
+
+Enable and start service with:
+```
+sudo systemctl enable ccats.service
+```
+and start it
+```
+sudo systemctl start ccats.service
+```