diff options
author | Katharina Fey <kookie@spacekookie.de> | 2016-07-30 21:26:43 +0200 |
---|---|---|
committer | Katharina Fey <kookie@spacekookie.de> | 2016-07-30 21:26:43 +0200 |
commit | 7d6b295c9e3f2ae3279039fb50f9e3bb0478074c (patch) | |
tree | e763e5698446c50b21adb9b43ddd95af39bd8657 /README | |
parent | 1337e4a7be1bc6db2bf820b1f5b55764c417b33a (diff) |
Initial commit of the library
Diffstat (limited to 'README')
-rw-r--r-- | README | 20 |
1 files changed, 20 insertions, 0 deletions
@@ -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 |