From 7d6b295c9e3f2ae3279039fb50f9e3bb0478074c Mon Sep 17 00:00:00 2001
From: Katharina Fey <kookie@spacekookie.de>
Date: Sat, 30 Jul 2016 21:26:43 +0200
Subject: Initial commit of the library

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

(limited to 'README')

diff --git a/README b/README
new file mode 100644
index 0000000..c918f0e
--- /dev/null
+++ b/README
@@ -0,0 +1,20 @@
+# libdyntree
+
+:tree: A dynamic n-ary tree to store recursive structures, key-value stores and single fields in a fast and comprehensive C datastructure.
+
+## How to build
+
+libdyntree is built with cmake. It has no external dependencies and compilation has been tested with gcc 6+ on Linx systems. It was tested with C11 but should be able to run on C99 or older.
+
+```console
+$> mkdir build; cd build
+$> cmake ..
+$> make -j 2
+```
+
+This will create a `.a` file. If you require a shared object, you can change the linking behaviour in the `CMakeLists.txt` file.
+
+
+## How to use
+
+Using libdyntree is straighforward with a comprehensive API. Everything resolves around `dtree` objects and providing fields to API functions. Every function is documented as outlined in the header files.
\ No newline at end of file
-- 
cgit v1.2.3