From f0e9fc6f44d59dd75eec74108299a3246c2d4336 Mon Sep 17 00:00:00 2001 From: Ruixiang Du Date: Mon, 8 Jul 2019 22:36:56 -0400 Subject: [PATCH] updated readme --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index c060ee9..9542dab 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,30 @@ * scout_bringup: launch and configuration files to start ROS nodes * scout_base: a ROS wrapper around Scout SDK to monitor and control the robot * scout_msgs: scout related message definitions +* (scout_robot: meta package for the Scout robot ROS packages) + +## Basic Usage + +1. Clone the packages into your catkin workspace and compile + + (the following instructions assume your catkin workspace is at: ~/catkin_ws/src) + + ``` + $ cd ~/catkin_ws/src + $ git clone https://github.com/westonrobot/scout_ros.git + $ cd .. + $ catkin_make + ``` + +2. Launch ROS nodes + +* Start the base node + + ``` + $ roslaunch scout_bringup scout_minimal.launch + ``` +* Start the keyboard tele-op node + + ``` + $ roslaunch scout_bringup scout_teleop_keyboard.launch + ```