From 4e2023d42ba632ce24da9933ae0d19d75187a7d5 Mon Sep 17 00:00:00 2001
From: oscar <os4g18@soton.ac.uk>
Date: Mon, 26 Apr 2021 17:26:42 +0100
Subject: [PATCH] cleared root for submission

---
 Refernces => Project/Refernces           |  0
 Research Notes => Project/Research Notes |  0
 finalNotes.txt => Project/finalNotes.txt |  0
 README.md                                | 37 +++++++++---------------
 4 files changed, 14 insertions(+), 23 deletions(-)
 rename Refernces => Project/Refernces (100%)
 rename Research Notes => Project/Research Notes (100%)
 rename finalNotes.txt => Project/finalNotes.txt (100%)

diff --git a/Refernces b/Project/Refernces
similarity index 100%
rename from Refernces
rename to Project/Refernces
diff --git a/Research Notes b/Project/Research Notes
similarity index 100%
rename from Research Notes
rename to Project/Research Notes
diff --git a/finalNotes.txt b/Project/finalNotes.txt
similarity index 100%
rename from finalNotes.txt
rename to Project/finalNotes.txt
diff --git a/README.md b/README.md
index 534d706..8b0591c 100644
--- a/README.md
+++ b/README.md
@@ -3,25 +3,18 @@
 # Project title: A Security Analysis of the FbHash Approximate Matching Algorithm
 
 setup:  
-make sure that the following commands work on your computer: make, git  
+ensure make and git installed
 git clone https://git.soton.ac.uk/os4g18/comp3200-individualproject-os4g18.git  
 cd ./comp3200-individualproject-os4g18/  
-sudo make install  
-  
-download YARA  
-copy setup  
-move module  
-rest of setup  
-  
-to run FbHash,  
-move to FbHash folder, view readme in there  
-  
-to run YARA  
-move to FbHash folder, view readme in there  
-  
-weekly report notes  
-  
-  
+sudo make install
+(run make yara for YARA dependencies, make hash if you want ssdeep and sdhash dependencies)
+
+to run FbHash,
+sudo make install in root,
+move to FbHash folder,
+python3 fbHash.py --help to view command list
+or view makefile to see some basic commands
+
 ProjectGoalsCheckList:  
 * [X] All Citations
 * [X] Lookup safe malware proccessing
@@ -31,15 +24,13 @@ ProjectGoalsCheckList:
 * [X] Get Feedback for Interim
 * [X] Submitt Interim
 * [X] Implement FbHash
-* [ ] Implement YARA
 * [X] Gather Malware Set 
 * [X] Eval FbHash
-* [ ] Eval YARA
-* [ ] Perform experiment
+* [X] Perform experiment
 * [X] Update Citations
 * [X] Write Final
-* [ ] Get Feedback for Final
-* [ ] Submitt Final
+* [X] Refine Final
+* [X] Submit Final
 * [ ] Plan Viva
-* [ ] Get Feedback for Viva
+* [ ] Prepare Viva
 * [ ] Viva
-- 
GitLab