From 16e52665c72a8f888414faaa614cd74fde5456cc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C5=81ukasz=20Czy=C5=BC?=
 <35401835+krawacik3@users.noreply.github.com>
Date: Mon, 2 Dec 2019 11:57:23 +0100
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cff8ea7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# svd2cpp
+Zero-cost abstraction register library generator.
+## What is *svd2cpp*?
+*svd2cpp* is a generator that parses .svd files provided by ARM chip vendor.
+It generates header file that allows for reading and writing to microcontroller's registers with zero overhead.
+
+## How to get *svd2cpp*?
+  Download source code and compile it. Note that this repo uses submodules thus do not forget to `git submodule init` and `git submodule update` after cloning.
+
+OR
+
+  Download precompiled parser.
+
+## How to use *svd2cpp*?
+That's super easy:
+```console
+./svd2cpp -i svdFile.svd -o generatedHeader.hpp
+```