adding project documentation and updating resources for v1.5

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Version 1.5
+
+* feature: nodes can be grouped into categories now, these are autocolored
+* fix: loading a cluster with many nodes created consistency errors for the next newly created node and its edges
+
+
 ## Version 1.4
 
 * feature: exports rico cluster as graphiz dot digraph file

NEXT_FEATURES.md

@@ -1,6 +1,8 @@
 # Collection of next features to implement
 
 * create preferences menu
-  * allow stylizing node labels (bold, italics, color)
-  * allow stylizing node color (fill, border)
-	* create presets, which can be overwritten
+	* allow modification of category colors
+	* allow selection of drawing method (ellipsies, rounded-rectangles)
+* create help dialog
+* create minimal handbook
+* create video showing off how to use rico-cluster-qt

README.md

@@ -73,6 +73,7 @@ After starting the application use the following input commands:
   * edge from node A to B
 	* edge from node B to A
 	* edge without any direction arrows
+* press number 0-5 with node(s) selected: nodes are assigned into autocolored categories (0 - is default category)
 
 ## Export as dot
 

resources/rico-cluster-qt-save.dot

@@ -1,12 +1,15 @@
 digraph "rico-cluster-qt-save" {
-node0 [label="Node A"];
-node1 [label="Node B"];
-node2 [label="Node C"];
-node3 [label="Node D\nThis is it"];
-node4 [label="Node E\nhas special size"];
+node0 [label="Node A", style=filled, fillcolor="#a1e0ea"];
+node1 [label="Node B", style=filled, fillcolor="#f6e3a8"];
+node2 [label="Node C", style=filled, fillcolor="#a1e0ea"];
+node3 [label="Node D\nThis is it", style=filled, fillcolor="#a1e0ea"];
+node4 [label="Node E\nhas special size", style=filled, fillcolor="#f6e3a8"];
+node5 [label="Node K", style=filled, fillcolor="#cecece"];
 node2 -> node1 [dir=none];
-node0 -> node1 [dir=none];
+node0 -> node1;
 node2 -> node3;
 node4 -> node2;
 node4 -> node1;
+node5 -> node1 [dir=none];
+node5 -> node2;
 }

resources/rico-cluster-qt-save.json

@@ -8,7 +8,7 @@
         },
         {
             "ID": 1,
-            "directed": 0,
+            "directed": 1,
             "nodeA-ID": 0,
             "nodeB-ID": 1
         },
@@ -29,19 +29,33 @@
             "directed": 1,
             "nodeA-ID": 4,
             "nodeB-ID": 1
+        },
+        {
+            "ID": 5,
+            "directed": 0,
+            "nodeA-ID": 5,
+            "nodeB-ID": 1
+        },
+        {
+            "ID": 6,
+            "directed": 2,
+            "nodeA-ID": 2,
+            "nodeB-ID": 5
         }
     ],
     "nodes": [
         {
             "ID": 0,
+            "category": 1,
             "nodecenter": {
-                "x": -384,
-                "y": -167
+                "x": 29,
+                "y": -183
             },
             "nodelabel": "Node A"
         },
         {
             "ID": 1,
+            "category": 3,
             "nodecenter": {
                 "x": -110,
                 "y": -300
@@ -50,6 +64,7 @@
         },
         {
             "ID": 2,
+            "category": 1,
             "nodecenter": {
                 "x": -294,
                 "y": -403
@@ -58,6 +73,7 @@
         },
         {
             "ID": 3,
+            "category": 1,
             "nodecenter": {
                 "x": -485,
                 "y": -509
@@ -66,12 +82,22 @@
         },
         {
             "ID": 4,
+            "category": 3,
             "nodecenter": {
                 "x": -45,
                 "y": -505
             },
             "nodelabel": "Node E\nhas special size"
+        },
+        {
+            "ID": 5,
+            "category": 0,
+            "nodecenter": {
+                "x": -374,
+                "y": -200
+            },
+            "nodelabel": "Node K"
         }
     ],
-    "version": 2
+    "version": 3
 }