From 9b6abcb3d7b754771cfae8353dafe7b840a829b5 Mon Sep 17 00:00:00 2001
From: Daniel Stonier <d.stonier@gmail.com>
Date: Wed, 22 May 2013 22:42:17 +0900
Subject: [PATCH] Instructions for a quick test.

---
 README.md | 34 ++++++++++++++++++++++++++++++++--
 1 file changed, 32 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 5aab0f9..fb3e514 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,34 @@
-rosjava_tools
+RosJava Tools
 =============
 
-Build tools for rosjava repositories.
+Build tools for rosjava and android repositories. Currently only includes tools for the rosjava repositories which are
+quite trivial, just a cmake macro. The android repository support has been done, but waiting to see how the android
+gradle plugin goes before dropping them back in here.
+
+
+Simple Demo
+===========
+
+```
+> mkdir -p ~/rosjava/src
+> cd ~/rosjava/src
+> catkin_init_workspace .
+> wstool init .
+> wstool set rosjava_tools --git https://github.com/ros-java/rosjava_tools -v hydro-devel
+> wstool set rosjava_core --git https://github.com/stonier/rosjava_core -v catkin_tools
+> wstool update
+> cd ~/rosjava
+> catkin_make
+```
+
+The only changes made to the `rosjava_core` repo was to add a `package.xml` with a depends on `rosjava_tools` and a
+changes to the `CMakeLists.txt` as follows:
+
+```
+...
+find_package(catkin REQUIRED rosjava_tools)
+
+catkin_rosjava_setup(install)
+```
+
+which just sets up dummy targets in the cmake configuration which call out to gradle in the actual make step.
-- 
GitLab