From 32c3ec3745f9bdf65ad0b0c5f5cba10d32e5bc56 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Th=C3=A9ophile=20Bastian?= <contact@tobast.fr>
Date: Fri, 20 Apr 2018 11:41:06 +0200
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e63c2bd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# Dwarf Assembly
+
+Some experiments around compiling the most used Dwarf informations (ELF debug
+data) directly into assembly.
+
+This project is a big work in progress, don't expect anything to be stable for
+now.
+
+## Dependencies
+
+As of now, this project relies on the following libraries:
+
+* libelf
+* libdwarf
+* [libdwarfpp](https://github.com/stephenrkell/libdwarfpp), itself depending on
+    - [libcxxfileno](https://github.com/stephenrkell/libcxxfileno)
+    - [libsrk31cxx](https://github.com/stephenrkell/libsrk31cxx)
+
+These libraries are expected to be installed somewhere your compiler can find
+them.