readme

acorbe · Jul 31, 2020 · 99fdb99 · 99fdb99
1 parent 7695775
commit 99fdb99
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
diff --git a/Readme.md b/Readme.md
@@ -1,8 +1,16 @@
-## Install
+# SociophysicsDataHandler
 
+Pedestrian dynamics data retriever for the Sociophysics courses at Eindhoven University of Technology.  
+
+Author: Alessandro Corbetta  
+mail: [email protected]  
+
+
+
+### Installation from source
 ```bash
 
 git clone <repo>
-pip install -e ./sociophysicsDataHandler
+pip install -e sociophysicsDataHandler/
 
 ```
diff --git a/sociophysicsDataHandler/spdh.py b/sociophysicsDataHandler/spdh.py
@@ -1,4 +1,7 @@
-"""specs etc.
+"""Pedestrian dynamics data retriever for the Sociophysics courses at Eindhoven University of Technology.
+
+Author: Alessandro Corbetta
+
 """
 
 import owncloud