From 502c335e06a10946ffe0a1da66a4037acbcb486f Mon Sep 17 00:00:00 2001
From: msurl <masur101@hhu.de>
Date: Wed, 27 May 2020 21:35:49 +0200
Subject: [PATCH] added readme

---
 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..9921c4a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# How to execute the code? 
+
+## via conda package
+1. Run `conda build /.../bachelor-mario-surlemont/python/conda\ package/k_hop_dominating_set_gurobi`
+2. Run `conda install --use-local k_hop_dominating_set_gurobi`
+3. Run `k_hop_dominating_set_gurobi -g /.../graph.lp -k k` with k being the parameter k of the k-hop dominating set. 
+
+To delete the package just run `conda uninstall --use-local k_hop_dominating_set_gurobi`
+
+:warning: Dependencies might not be installed automatically. You will need the packages _networkx_, _gurobipy_, _matplotlib_!
+
+## as python script
+You can use the file *k\_hop\_dom\_set.py* as a python script. 
+
+Usage: `python k_hop_dom_set.py /.../graph.lp k` with k being the parameter k of the k-hop dominating set. 
+
+:warning: the import of _lp_to_nx_graph_ is commented out. This needs to be changed prior to use. 
-- 
GitLab