From 52787c11171b80e1f651bc22839eb01553112014 Mon Sep 17 00:00:00 2001
From: Max Moser <e1326252@student.tuwien.ac.at>
Date: Fri, 15 Dec 2017 17:09:30 +0100
Subject: [PATCH] Add README.md for project description

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..48c0071
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# Network-Manager VPN Plugin for Wireguard
+
+## Compilation
+* `./autogen.sh`
+* `make`
+
+## Modifying the source (Visual Studio Code)
+* Open the folder in Code
+* Do the compilation steps as above
+* `cat Makefile | ./includes2strings.py`
+* take the output of the script and put it in the appropriate section of `.vscode/c_cpp_properties.json` (for me: appended to `includePath` of configuration `Linux`)
+
+## Execution
+The following section briefly describes how to start the stuff for testing purposes
+
+* `./src/nm-openvpn-service --bus-name org.freedesktop.NetworkManager.wireguard` to start the plugin
+* `examples/dbus/dbus.py` to send Disconnect() to the plugin
\ No newline at end of file