From 887d7f5244ea1bb97264d2f292e5c0a14d04e208 Mon Sep 17 00:00:00 2001
From: Sergey Yagovtsev <yse.sey@gmail.com>
Date: Wed, 31 Aug 2016 22:47:17 +0300
Subject: [PATCH] Update README

---
 README.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 49 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 035eb50..57f5709 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,58 @@
 # easy_profiler [![License](https://img.shields.io/badge/license-GPL3-blue.svg)](https://github.com/yse/easy_profiler/blob/develop/COPYING)[![Build Status](https://travis-ci.org/yse/easy_profiler.svg?branch=develop)](https://travis-ci.org/yse/easy_profiler)
+
+1. [About](#about)
+2. [Build](#build)
+    - [Linux](#linux)
+    - [Windows](#windows)
+3. [Usage](#usage)
+
+
+# About
 Lightweight profiler library for c++ 
 
 You can profile any function in you code. Furthermore this library provide profiling of any block of code.
 
+# Build
+
+## Prerequisites
+
+For core:
+* compiler with c++11 support
+* cmake 3.0 or later
+
+For GUI:
+* Qt 5.3.0 or later
+
+## linux
+
+```bash
+$ mkdir build
+$ cd build
+$ cmake ..
+$ make
+```
+
+## windows
+
+If you use qtcreator IDE you can just open `CMakeLists.txt` file in root directory.
+
+If you use Visual Studio you can generate solution by cmake command. In this case you should specify path to cmake scripts in Qt5 dir (usually in lib/cmake subdir), for example:
+```batch
+$ mkdir build
+$ cd build
+$ cmake -DCMAKE_PREFIX_PATH="C:\\\\Qt\\\\5.3\\\\msvc2013_64\\\\lib\\\\cmake" ..
+```
+
+# Usage
+
+First of all you can specify path to include directory which contains `include/profiler` directory. For linking with ease_profiler you can specify path to library.
+
 Example of usage.
 
 This code snippet will generate block with function name and grouped it in Magenta group:
 ```cpp
+#include <profiler/profiler.h>
+
 void frame(){
 	PROFILER_BEGIN_FUNCTION_BLOCK_GROUPED(profiler::colors::Magenta);
 	prepareRender();
@@ -15,6 +61,8 @@ void frame(){
 ```
 To profile any block you may do this as following:
 ```cpp
+#include <profiler/profiler.h>
+
 void frame(){
 	//some code
 	PROFILER_BEGIN_BLOCK("Calculating summ");
@@ -24,4 +72,4 @@ void frame(){
 	PROFILER_END_BLOCK;
 }
 ```
-[![Analytics](https://ga-beacon.appspot.com/UA-82899176-1/easy_profiler/readme)](https://github.com/yse/easy_profiler)
\ No newline at end of file
+[![Analytics](https://ga-beacon.appspot.com/UA-82899176-1/easy_profiler/readme)](https://github.com/yse/easy_profiler)