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

Document macOS caveats on binary installation tutorial #116

Closed
chapulina opened this issue Nov 5, 2020 · 5 comments
Closed

Document macOS caveats on binary installation tutorial #116

chapulina opened this issue Nov 5, 2020 · 5 comments
Assignees
Labels
📜 blueprint Ignition Blueprint 🏰 citadel Ignition Citadel documentation Improvements or additions to documentation 🔮 dome Ignition Dome 🏢 edifice Ignition Edifice macOS macOS support

Comments

@chapulina
Copy link
Contributor

The install tutorial for macOS from source lists caveats and extra tips to get Ignition to work:

https://ignitionrobotics.org/docs/citadel/install_osx_src

While the binary install tutorial suggests that everything will just work out of the box:

https://ignitionrobotics.org/docs/citadel/install_osx

We should make sure that users installing from binaries are aware of caveats and any extra steps needed.

@chapulina chapulina added documentation Improvements or additions to documentation 📜 blueprint Ignition Blueprint 🏰 citadel Ignition Citadel 🔮 dome Ignition Dome macOS macOS support 🏢 edifice Ignition Edifice labels Nov 5, 2020
@chapulina chapulina assigned ahcorde and unassigned scpeters Feb 4, 2021
@ahcorde
Copy link
Contributor

ahcorde commented Mar 1, 2021

@chapulina
Copy link
Contributor Author

Thanks, @ahcorde . Are you working on more PRs or do these cover everything?

CC @scpeters

@ahcorde
Copy link
Contributor

ahcorde commented Mar 2, 2021

These are the two issues that I have found. Maybe I can add the gazebo_scene_viewer as an alternative to visualize what's going on in the scene.

What do you think ?

@chapulina
Copy link
Contributor Author

I think the main problem is the sentence "All libraries should be ready to use and the ign gazebo app ready to be executed.", which gives the impression that everything should just work. I think we should document in those tutorials that the 3D scene doesn't work and that ign gazebo should only be run headless, see gazebosim/gz-sim#477 as a reference.

We should document this for Citadel, Dome and Edifice.

@chapulina
Copy link
Contributor Author

I see this is already documented

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📜 blueprint Ignition Blueprint 🏰 citadel Ignition Citadel documentation Improvements or additions to documentation 🔮 dome Ignition Dome 🏢 edifice Ignition Edifice macOS macOS support
Projects
None yet
Development

No branches or pull requests

3 participants