updated readme

readme.md

@@ -1,4 +1,4 @@
-### Information Modelling & Analysis: Project 1
+# Information Modelling & Analysis: Project 1
 
 Student: *enter your name here*
 
@@ -10,3 +10,21 @@ For your convenience, the source code to be analyzed (xerces2)
 **Attention**: Please consider the submission instructions available on iCorsi.
 
 **Report**: You may want to use the template distributed on iCorsi.
+
+## Install dependencies
+
+```shell
+# create venv
+python -m venv env
+source env/bin/activate
+
+pip3 install -r requirements.txt
+```
+
+## Run *find god classes*
+
+```shell
+./find_god_classes.py
+```
+
+The resulting CSV file containing a list of God classes is generated in the `god_classes/god_classes.csv` path.