From aa7c8bbd9c7d275df46c91cd1b7a60eabb51e025 Mon Sep 17 00:00:00 2001
From: capossele <angelo@Angelo.local>
Date: Mon, 20 May 2019 09:29:18 +0100
Subject: [PATCH] Refactor: README updated

---
 README.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)

diff --git a/README.md b/README.md
index ed2f79d2..6d4b4e21 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,39 @@
 # goshimmer
+
+## Run Shimmer
+
+First, you need to [install Go](https://golang.org/doc/install) if it is not already installed on your machine. It is recommended that you use the most recent version of Go.
+
+### Requirements
+
+- gcc: Some packages in this repo might require to be compile by gcc. Windows users can install [MinGW-gcc](http://tdm-gcc.tdragon.net/download). 
+
+## Build
+
+If you need to develop locally and be able to build by using your local code, i.e., without waiting for pushing your commits on the repo, clone the repository directly inside the `src` folder of your `$GOPATH` with the command:
+
+```
+git clone git@github.com:iotaledger/goshimmer.git
+```
+
+or if you prefer https over ssh
+
+```
+git clone https://github.com/iotaledger/goshimmer.git
+```
+
+To download and install all the package dependencies just run:
+```
+go get github.com/iotaledger/goshimmer
+```
+
+You can build your executable (as well as cross compiling for other architectures) by running the `go build` tool inside the just cloned folder `goshimmer`:
+
+```
+go build -o shimmer
+```
+You can then run by:
+
+```
+./shimmer
+```
\ No newline at end of file
-- 
GitLab