From 541a13b352587cf93a96f30d4b487ede5cc70882 Mon Sep 17 00:00:00 2001 From: Claudio Maggioni Date: Mon, 6 Mar 2023 15:05:24 +0100 Subject: [PATCH] updated readme --- readme.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index f90c17f..87c272e 100644 --- a/readme.md +++ b/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.