From 8b208a1f7a8875020c769e88b40b2217fd860ba5 Mon Sep 17 00:00:00 2001
From: Alejandro Lopez Gestoso <alopez@iri.upc.edu>
Date: Thu, 21 Feb 2019 15:32:29 +0100
Subject: [PATCH] Added ReadMe.md file

---
 ReadMe.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 59 insertions(+)
 create mode 100644 ReadMe.md

diff --git a/ReadMe.md b/ReadMe.md
new file mode 100644
index 0000000..a9cdd84
--- /dev/null
+++ b/ReadMe.md
@@ -0,0 +1,59 @@
+Scripts-catkin
+==============
+
+## Description
+
+Set of scripts to easily generate driver and algorithm packages in ROS, and also a set of scripts to add publishers, subscribers, service clients an servers and action clients and servers to an existing package.
+
+## Installation
+
+- Clone this repository: `git clone ssh://git@gitlab.iri.upc.edu:2202/labrobotica/ros/iri_core/scripts-catkin.git -b kinetic_migration scripts`
+
+- Install realpath:`sudo apt-get install realpath`
+
+- ``echo "source `pwd`/scripts/setup.bash" >> ~/.bashrc``
+
+- `source ~/.bashrc`
+
+## How to use it
+
+### create_algorithm_package.sh and create_driver_package.sh
+
+These scripts have the following arguments:
+
+- -n node\_name: The node's name. It has a default 'iri\_' prefix.
+- -i : (optional) Avoid adding the default iri_ prefix to the provided node name.
+- -p prefix: (optional) Replaces default 'iri\_' prefix with specified 'prefix\_'.
+
+### add_topic_publisher_subscriber.sh
+
+This script has the following parameters:
+
+- -o \[publisher, subscriber\]: To add a publisher or a subscriber.
+- -p ros\_pkg\_name: The target ros package.
+- -t topic\_name: The topic's name. It musn't have a backslash (\\).
+- -m message: The topic's message.msg.
+- -b buffer\_length: The buffer's length (usually 1).
+
+### add_service_server_client.sh
+
+This script has the following parameters:
+
+- -o \[server, client\]: To add a service server or client.
+- -p ros\_pkg\_name: The target ros package.
+- -s service\_name: The service's name. It musn't have a backslash (\\).
+- -m service: The service's service.srv.
+
+### add_action_server_client.sh
+
+- -o \[server, client\]: To add aaction server or client.
+- -p ros\_pkg\_name: The target ros package.
+- -a action\_name: The action's name. It musn't have a backslash (\\).
+- -m message: The action's message.action.
+
+
+
+
+
+
+
-- 
GitLab