From ce85ab94d40efd9225db93b4e0694083edf02030 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C5=81ukasz=20Plewa?= <lukasz.plewa@intel.com>
Date: Wed, 5 Dec 2018 15:29:12 +0100
Subject: [PATCH] =?UTF-8?q?In=20the=20beginning,=20the=20code=20was=20with?=
 =?UTF-8?q?out=20form=20and=20was=20void()=E2=80=A6?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..b412948b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+libvmemcache: buffer based LRU cache
+=======================================
+
+# Building The Source #
+
+Requirements:
+- libpmem-dev(el) >= 1.3 (http://pmem.io/pmdk/)
+- libpmemobj-dev(el) >= 1.3 (http://pmem.io/pmdk/)
+- cmake >= 3.3
+- git
+
+For all systems:
+
+```sh
+$ git clone https://github.com/lplewa/vmemcache.git
+$ cd vmemcache
+$ mkdir build
+$ cd build
+$ cmake .. -DCMAKE_INSTALL_PREFIX=/home/user/vmemchache-bin
+$ make
+$ make install
+```