From 62eb5a23a797bf23c747ac6a92f5a3cdd5c2a886 Mon Sep 17 00:00:00 2001
From: Robert Baldyga <robert.baldyga@intel.com>
Date: Mon, 4 Feb 2019 11:05:47 +0100
Subject: [PATCH] Add examples and build test info to Readme

Signed-off-by: Robert Baldyga <robert.baldyga@intel.com>
---
 README.md | 32 ++++++++++++++++++++++++++++----
 1 file changed, 28 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 1935b37..22fb6f0 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # Open CAS Framework
 
-Open CAS Framwework (OCF) is high performance block storage caching meta-library
+Open CAS Framework (OCF) is high performance block storage caching meta-library
 written in C. It's entirely platform and system independent, accessing system API
 through user provided environment wrappers layer. OCF tightly integrates with the
 rest of software stack, providing flawless, high performance, low latency caching
@@ -11,7 +11,9 @@ utility.
 * [Documentation](#documentation)
 * [Source Code](#source)
 * [Deployment](#deployment)
-* [Unit Tests](#tests)
+* [Examples](#examples)
+* [Unit Tests](#unit_tests)
+* [Build Test](#build_test)
 * [Contributing](#contributing)
 
 <a id="documentation"></a>
@@ -54,7 +56,18 @@ make -C $OCFDIF src O=$SRCDIR CMD=cp
 make -C $OCFDIF inc O=$INCDIR CMD=cp
 ~~~
 
-<a id="tests"></a>
+<a id="examples"></a>
+## Examples
+
+OCF is shipped with examples, which are complete, compillable and working
+programs, containing lot of comments that explain basics of caching. They
+are great starting point for everyone who wants to start working with OCF.
+
+Examples can be found in directory `example/`.
+
+Each example contains Makefile which can be used to compile it.
+
+<a id="unit_tests"></a>
 ## Unit Tests
 
 OCF is shipped with dedicated unit test framework based on Cmocka.  
@@ -66,7 +79,18 @@ To run unit test you need to install following packages:
 To run unit tests use following command:
 
 ~~~{.sh}
-./tests/ut-framework/run_unit_tests.py
+./tests/unit/framework/run_unit_tests.py
+~~~
+
+<a id="build_test"></a>
+## Build Test
+
+OCF repository contains basic build test. It uses default POSIX environment.
+To run this test, use following commands:
+
+~~~{.sh}
+cd tests/build/
+make
 ~~~
 
 <a id="contributing"></a>