From 22a566cd43a6e8a20881ce3b0b27f4d6f193b9c1 Mon Sep 17 00:00:00 2001
From: Steffen Knapp <knapps@cl.uni-heidelberg.de>
Date: Sun, 7 Jan 2018 18:19:16 +0100
Subject: [PATCH] improved readme

---
 README.md | 42 ++++++++++++++++++++++++++++++------------
 1 file changed, 30 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 5f29f1f..36f6e9b 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,36 @@
-Moin!
+# Sarcasm Detection In Amazon Reviews
 
-Hallo
+## About
 
-# Software Projekt WS17 - Sarcasm Detection
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
 
+## Prerequirements 
 
-## (Current) Dependencies:
+We suggest using a virtual environment in order to use this program.
 
-Installation via 'pip install [package]'
+	# apt install python-virtualenv
 
-- nltk
-- numpy
-- vaderSentiment (2.5)
-- requests
-- textblob
-- sklearn
-- scipy
\ No newline at end of file
+You then need to create a new virtual environment (in this example, it is named virtual-env), preferably in the project's folder:
+
+	$ virtualenv virtual-env
+	$ source virtual-env/bin/activate
+
+## Requirements
+
+The program requires NLTK, NumPy, SciPy, SciKit Learn, requests, textblob and vaderSentiment.
+Please note that SciPy and NumPy need to be installed before SciKit Learn.
+
+    $ pip install --upgrade pip
+	$ pip install nltk
+	$ pip install numpy
+	$ pip install scipy
+	$ pip install sklearn
+	$ pip install requests
+	$ pip install textblob
+	$ pip install vaderSentiment
+	
+## Starting
+
+The command for using the program is as follows: 
+
+	$ python ...
-- 
GitLab