From 469da203a035e4cbd3896d728f0cca4f0a532813 Mon Sep 17 00:00:00 2001
From: "Kirillova, Tatiana" <tatiana.kirillova@student.tugraz.at>
Date: Mon, 15 Jan 2024 01:43:57 +0100
Subject: [PATCH] added readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..930d564
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+### BONUS 
+Written in *python v3.10.12*
+
+##### Instructions:
+
+Just run the code. 
+
+There are some tests that are run automatically. 
+
+Uncomment ```randomTest(i)``` to run i random tests. Change the randomness ranges inside the function if needed.
+
+Add new tests by creating a graph:
+```Graph(name, name, delta, nodes, edges)```
+and adding it to the list of graphs in the test function.
+
+Alternatively, use the ```graphComplete(delta)``` function to create a complete graph with a maximum degree delta or ```graphRandom()``` to create a random graph (the min/max degree and node number ranges can be chosen). Add it to the list of graphs. 
+
+##### Good to know:
+
+Use ```isDegreeCorrect(graph)``` function to check if none of the nodes in the graph exceeds the supposed maximum degree.
+
+Uncomment the printing statement in the ```compute(graph)``` function to print all of the edges and the assigned colors.
-- 
GitLab