-
Notifications
You must be signed in to change notification settings - Fork 32
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
Tutorial about developing with cmake and colcon #145
Conversation
Signed-off-by: Michael Carroll <[email protected]>
51fa1b6
to
e812519
Compare
Signed-off-by: Michael Carroll <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You should include the tutorial in the tutorial.md.in file
Signed-off-by: Michael Carroll <[email protected]> Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Michael Carroll <[email protected]>
Done, thanks for catching that. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
"-DCMAKE_CXX_COMPILER_LAUNCHER=ccache" | ||
``` | ||
|
||
### Enabling/Disabling Documentation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You could also have a section for BUILD_TESTING
, and BUILDSYSTEM_TESTING
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! Some of the tips were new to me. I just have some suggestions. I think this works well as a reference page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mostly minor comments. This is very helpful, and I learned some new tricks I'll have to try out some time!
mkdir -p ~/ign_edifice/src | ||
cd ~/ign_edifice/ | ||
wget https://raw.githubusercontent.com/ignition-tooling/gazebodistro/master/collection-edifice.yaml | ||
vcs import src < collection-edifice.yaml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should add a note about installing vcs
in case users don't have this installed already.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have a note in the level 2 section that redirects to the ignition source installation documentation that should cover this, is that sufficient?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I had the same thought after I commented. Perhaps we can just mention users should go back to section 2 if they don't have vcs
installed yet?
Co-authored-by: Louise Poubel <[email protected]> Co-authored-by: Ashton Larkin <[email protected]> Signed-off-by: Michael Carroll <[email protected]>
Signed-off-by: Michael Carroll <[email protected]>
Try to document a bit around useful CMake flags as well as interaction with colcon and how to speed up builds.
I'm open to relocating this if there is somewhere more useful.
Signed-off-by: Michael Carroll [email protected]