From 545457510a30589305238aa6e3a143255c7eb14c Mon Sep 17 00:00:00 2001 From: Alex Davies Date: Thu, 19 Sep 2024 13:07:22 -0300 Subject: [PATCH] Added better docs --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index c06d4d0..f6bc34a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ +# template-service-ros1-catkin + +This template is intended to be used with VSCode and the [spiri-sdk](https://git.spirirobotics.com/Spiri/spiri-sdk). + +This template will set up a package, a development container, and attach it to the ros-master running on the SDK's simulated +robot. + +You will be asked a number of questions when applying the template. + +Take a look at the following tutorials for more information: + +http://wiki.ros.org/ROS/Tutorials/WritingPublisherSubscriber%28python%29 + +http://wiki.ros.org/ROS/Tutorials/WritingPublisherSubscriber%28c%2B%2B%29 + + +## Copier template + This is a template for use with [copier](https://github.com/copier-org/copier). To get started run `copier copy https://git.spirirobotics.com/Spiri/template-service-ros1-catkin.git ./` inside your git repo.