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

Update tutorial build step #626

Open
wants to merge 3 commits into
base: gz-math8
Choose a base branch
from
Open

Conversation

alesof
Copy link

@alesof alesof commented Aug 30, 2024

🐢 Tutorial Update

Related to #1362

Summary

Unifies building steps for unix and win using cmake instead of pkg-config.

Unifies building steps for unix and win using cmake.

Signed-off-by: Alessandro Sofia <[email protected]>
@github-actions github-actions bot added the 🏛️ ionic Gazebo Ionic label Aug 30, 2024
@alesof alesof changed the title Update cppgetstarted.md Update tutorial build step Aug 30, 2024
Update to build it from windows

Signed-off-by: Alessandro Sofia <[email protected]>
Copy link
Contributor

@azeey azeey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Just a small suggestion to use modern CMake for linking libraries.

tutorials/cppgetstarted.md Outdated Show resolved Hide resolved
Co-authored-by: Addisu Z. Taddese <[email protected]>
Signed-off-by: Alessandro Sofia <[email protected]>
@alesof
Copy link
Author

alesof commented Aug 31, 2024

Thank you for the suggestion, I was following the style of the other tutorial, should it be changed also there?

@azeey
Copy link
Contributor

azeey commented Aug 31, 2024

Thank you for the suggestion, I was following the style of the other tutorial, should it be changed also there?

Yeah, I think we should change that as well


```{.bash}
c++ $(pkg-config --cflags gz-math8) main.cpp -o main
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```
```{.bash}

The program can then be run as:
Compile the example:

```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```
```{.bash}

Comment on lines +89 to +92
For Unix systems:
```
make
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For Unix systems:
```
make
```
For Unix systems:
```{.bash}
make

Comment on lines +94 to +97
For Windows systems:
```
cmake --build . --config Release
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For Windows systems:
```
cmake --build . --config Release
```
For Windows systems:
```{.bash}
cmake --build . --config Release

Distance from 1 3 5 to 2 4 6 is 1.73205
```


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove this new line

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏛️ ionic Gazebo Ionic
Projects
Status: In review
Development

Successfully merging this pull request may close these issues.

3 participants