From 2831f9f150ad878a4ad6974df9aeb14e6e248a2c Mon Sep 17 00:00:00 2001
From: Egor Tensin <Egor.Tensin@gmail.com>
Date: Mon, 22 May 2017 23:14:07 +0300
Subject: add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ba1860c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,47 @@
+PDB repository
+==============
+
+Want to conduct a post-mortem analysis, but all you've got is a bunch of PDB
+files and a call stack?
+Say no more!
+With the unique set of tools provided by this project, you'll never feel
+hopeless again.
+Do all kinds of crazy shit like resolving symbol names from their addresses &
+vice versa, etc.
+
+Prerequisites
+-------------
+
+* Boost.Filesystem
+* Boost.Program_options
+* Boost.System
+
+Building
+--------
+
+Create the build files using CMake and build using Visual Studio.
+For example, using Visual Studio 2015 Update 3 (targetting x86-64 and using
+static Boost libraries):
+
+```
+> cd
+C:\workspace\build\pdb-repo\msvc\x64
+
+> cmake -G "Visual Studio 14 2015 Win64"                ^
+    -D BOOST_ROOT=C:\workspace\third-party\boost_1_61_0 ^
+    -D Boost_USE_STATIC_LIBS=ON                         ^
+    -D Boost_USE_STATIC_RUNTIME=ON                      ^
+    C:\workspace\personal\pdb-repo
+...
+
+> cmake --build . --config release -- /m
+...
+```
+
+License
+-------
+
+Distributed under the MIT License.
+See [LICENSE.txt] for details.
+
+[LICENSE.txt]: LICENSE.txt
-- 
cgit v1.2.3