From 00bf96c6a90b9687571f9d393555998d0b02bb03 Mon Sep 17 00:00:00 2001
From: Vincenzo Marciano <marcianovincenzomv@gmail.com>
Date: Wed, 19 Apr 2023 12:38:14 +0200
Subject: [PATCH] Create README.md

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1fc2093
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# TheUniversityOfSheffield
+Code for the internship @The University of Sheffield.
+
+## How-to:
+1) Run 'data_generation.py' which exploits 'data_generator.py' to generate data starting from the indicated subject folder. It relies on "fist_test.ipynb" in the _notebooks_ folder
+2) Run 'main.py' which exploits 'weather_analysis.py' to run a weather analysis on cadence etc, generating a statistics file in the _output path_ indicated as argument in the command line.
+
+## Where-to:
+* _notebooks_ contains the experimental notebooks that visually represent the pipeline to generate the files, step by step
+* _.py files_ are the files designated to work in a command-line fashion from your terminal.
+
+