From 9afd07dc179e68ccb411576cb33af78894aba417 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Simon=20St=C3=BCrz?= <simon.stuerz@guh.io>
Date: Tue, 26 Jun 2018 08:40:25 +0200
Subject: [PATCH] Update readme file

---
 README.md | 44 ++++++++++++++++++++++++++------------------
 1 file changed, 26 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index d69dd5ed..2649da50 100644
--- a/README.md
+++ b/README.md
@@ -1,40 +1,48 @@
-# mea
+# nymea-app
+
 QtQuick nymea client application
 
 # building
 
 Required packages:
-It is recommended to install a complete Qt installation. Minimum required Version 5.7.
+It is recommended to install a complete Qt installation. Minimum required Qt Version *5.7.0*.
+
 No extra modules are required for a basic desktop build.
 
 After cloning the repository, run
 
-$ git submodule init
-$ git submodule update
+    $ git submodule init
+    $ git submodule update
 
 To build a binary run
-$ mkdir builddir
-$ cd builddir
-$ qmake path/to/source/dir
-$ make
 
-Or open mea.pro in QtCreator and click the "Play" button.
+    $ mkdir builddir
+    $ cd builddir
+    $ qmake path/to/source/dir
+    $ make
+
+Or open `nymea-app.pro` in QtCreator and click the **"Play"** button.
 
 Optional configuration flags to be passed to qmake:
-- CONFIG+=withtests
-  Enables building the testrunner target
 
-Notes for Android:
+- `CONFIG+=withtests`
+
+> Enables building the testrunner target
+
+## Android
 As Qt can't bundle a build of openssl for android, you need to place a copy to
-/opt/android-ssl/
+`/opt/android-ssl/`
+
+## Windows
 
-Notes for Windows:
 There is an additional make target named "wininstaller" available. You need to
 have windeployqt and binarycreator (from Qt Install Framework 3.0) in your
 system's Path.
 
-# running the tests
-Required Packages:
-- qtdeclarative5-test-plugin
-- nymead
+# Running the tests
+
+Required Packages:
+
+- `qtdeclarative5-test-plugin`
+- `nymead`