From ed4b406954614858a962430f71888c545f560921 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89der=20Ferreira=20Zulian?= <fzeder@rhrk.uni-kl.de>
Date: Tue, 21 Apr 2015 14:41:14 +0200
Subject: [PATCH] Readme file improved but not yet finished.

Added *.swp (vim swap files extension) to gititnore.
---
 .gitignore |  1 +
 README.md  | 42 ++++++++++++++++++++++++++++++++++++++----
 2 files changed, 39 insertions(+), 4 deletions(-)

diff --git a/.gitignore b/.gitignore
index 897984aa..fe3e5e06 100644
--- a/.gitignore
+++ b/.gitignore
@@ -15,3 +15,4 @@
 dram/build-*/
 ._.DS_Store
 .DS_Store
+*.swp
diff --git a/README.md b/README.md
index 59e654e9..3607b6fb 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,46 @@
 de.uni-kl.ems.dram.vp.system
 ============================
 
-Generic DRAM controller
+Generic DRAM controller simulator and debug tools related to it.
 
-#Setup with QTCreator
+# Basic Setup
 
-needs update!
+In a terminal window execute the commands that follow (the '$' symbolizes the
+terminal prompt).
 
- 
+Go to your home directory.
+$ cd
+
+Create a directory for your projects.
+$ mkdir projects
+
+Clone the repository (in case of doubts about which repository you should
+clone ask your supervisor).
+$ git clone https://<user>@git.rhrk.uni-kl.de/<user>/dram.vp.system.git
+
+Go to the projetct directory
+$ cd dram.vp.system
+
+Execute the script that follows.
+$ install_prerequisites.sh
+
+## With QTCreator
+Execute the *qtcreator*.
+$ qtcreator &
+
+Use the menu bar and open the DRAMSys project.
+**File -> Open Project -> dram.vp.sys/dram/dramSys/dramSys.pro**
+
+When you open the project for the first time a configuration window pops-up.
+Then click in **Configure Project** and after that **Build** the project.
+
+
+## Without QTCreator
+
+$ cd dram
+$ mkdir build
+$ cd build
+$ qmake ../dramSys/dramSys.pro
+$ make