diff --git a/ReadMe.md b/ReadMe.md index a9cdd8402dfcb724eaa456f3763f03d7ac2f7d0b..229427703bf60bc9b41cdd6bc33b9c4d31602d1c 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -21,35 +21,35 @@ Set of scripts to easily generate driver and algorithm packages in ROS, and also 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\_'. +- **-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). +- **-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 must not have a backslash (\\) nor any whitespace characters**. +- **-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. +- **-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 must not have a backslash (\\) nor any whitespace characters**. +- **-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. +- **-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 must not have a backslash (\\) nor any whitespace characters**. +- **-m message**: The action's message.action.