From ae4a38659fe4440a8bf4affe5fb2b91512fa9b2d Mon Sep 17 00:00:00 2001
From: Alejandro Lopez Gestoso <alopez@iri.upc.edu>
Date: Fri, 28 Jun 2019 10:59:34 +0200
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4098da0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+IRI BehaviorTree
+==============
+
+## Description
+
+It's a library to adapt the [behaviortree](https://github.com/BehaviorTree/BehaviorTree.CPP) library to the use
+of [IRI modules](https://gitlab.iri.upc.edu/labrobotica/ros/iri_core/iri_ros_tools).
+
+It provides the possibility of creating asynchronous actions without the need of creating a class. Its *tick* 
+function is called from the main thread. There isn't implemented any *halt* function.
+
+## ROS dependencies
+
+- [behaviortree_cpp_v3](https://github.com/BehaviorTree/BehaviorTree.CPP)
+
+## Installation
+
+- Move to workspace: `roscd && cd ../src`
+- Clone the repository: `git clone https://gitlab.iri.upc.edu/labrobotica/ros/iri_core/iri_behaviortree.git`
+- Compile:  `roscd && cd .. && catkin_make -DCMAKE_BUILD_TYPE=Release`
+
+## How to use it
+
+Substitute the *BehaviorTreeFactory* object with an *IriBehaviorTreeFactory* object. To add an *IriAsyncActionNode* 
+just call *registerIriAsyncAction* on the same way that a *registerSimpleAction* would be called.
\ No newline at end of file
-- 
GitLab