Kinovarobotics / ros_kortex

ROS packages for KINOVA® KORTEX™ robotic arms
Other
156 stars 156 forks source link

ROS1 and Docker Working -- Where to Put Info in the Repo? #328

Open peasant98 opened 1 month ago

peasant98 commented 1 month ago

Summary

I have a working example of using Docker and ROS1 to control the Kinova Gen3 arm. I listed my steps here: https://reflective-blinker-149.notion.site/Kinova-with-ROS1-and-Docker-6e344ad97a204835a123a1cd7b0aa7cc. I was wondering where I could put this information in the repo -- with more detailed information in the repo.

Use case

This tutorial will give users an easy way to control the Kinova Gen3 robot with Docker. The hope is that people who have newer versions of Ubuntu, Mac, and Windows could get this up and running.

Alternatives

NA

Possible issues

NA

Additional context

NA

martinleroux commented 1 month ago

Hi @peasant98 , thank you for your contribution.

If you intend to maintain this yourself, I would recommend creating your own repo, and then making a pull request adding a .md file in the 3rd Party folder of the ros_kortex repository to list it as a supported 3rd party tool (if you decide to go this way, let me know and I'll create the file in place and you will be able to simply add your link with a short description).

If you don't intend to maintain this yourself, you can create a Pull request after putting your content in a new subfolder of the 3rd party folder. It will need to go through our usual review process - I can already tell you that some rewording in your instructions would be required (while it is true that at the time of writing our ROS1 driver is more complete than for ROS2, we have plenty of improvements in our backlog that we are hoping to push in the next year).