Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README file? #144

Open
ppbrown opened this issue Sep 19, 2022 · 4 comments
Open

README file? #144

ppbrown opened this issue Sep 19, 2022 · 4 comments
Labels
help wanted Extra attention is needed

Comments

@ppbrown
Copy link

ppbrown commented Sep 19, 2022

could we please have a top level README file for how to build these things?
I'm completely new to ros and catkin. I learn things best by seeing them work.
But I dont know how to get the build process to work here :(

@audrow
Copy link
Contributor

audrow commented Sep 19, 2022

We have the documentation elsewhere.

Here's the documentation for building on ROS 1 (you can also find other tutorials here):
http://wiki.ros.org/ROS/Tutorials/BuildingPackages

Here's documentation for ROS 2:
https://docs.ros.org/en/rolling/Tutorials/Beginner-Client-Libraries/Colcon-Tutorial.html

I'm going to mark this as help-wanted since it would be nice to have this, even though this info is covered in tutorials.

@audrow audrow added the help wanted Extra attention is needed label Sep 19, 2022
@ppbrown
Copy link
Author

ppbrown commented Sep 19, 2022

thats fair... but how about just putting the info you put right here, into a top level readme file?

@ppbrown
Copy link
Author

ppbrown commented Sep 19, 2022

although.. are both those links relevant? is the tutorial code here, equally valid for both ROS1 and ROS2?

@audrow
Copy link
Contributor

audrow commented Sep 30, 2022

Somewhat confusingly, this repo has both ROS 1 and ROS 2 branches, so both would apply to their corresponding branches.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants