readme

README.md

@@ -0,0 +1,28 @@
+
+
+All source code for cosc datavisualisation project. 
+
+- `store_history.py`
+    - script for walking a git history and storing deltas in an SQLite3 database
+- `treesitter-analysis`
+    - C++ program for walking a source directory and analysing the C code 
+     contained. Statistics on every comment and function declaration are stored 
+     to an SQLite database. 
+-  `window.py`
+    - Entry point to the treemap plotting program. 
+    - `treeplot.py` plot drawing functionality using Skia
+    - `read_db.py` functions for copying attributes from a database into 
+        the treemap
+
+
+Usage **MULTI-STAGE BUILD**
+
+
+1. Create a database using `treesitter-analysis` or `store_history.py` 
+2. Clone c-colours and compile the python library, copy the resulting `.so` into
+    the same directory as `window.py` 
+2. Edit window.py to load the data you want
+3. `pip install -r requirements.txt`
+4. Run window.py
+
+![](commitactivityheatmap.png)