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

Add Windows installation #161

Closed
wants to merge 2 commits into from
Closed

Conversation

mabelzhang
Copy link
Contributor

Partially addresses gazebosim/docs#117

Moved Documentation and Testing sections from the installation tutorial back to README - looks like a mistake that they were moved before. These two sections stayed in the README for other libraries.

One of the dependencies, libignition-rendering, is not yet on conda-forge and needs to be installed from source.
libignition-gui is also not on conda-forge, so we don't have binary install instructions for Windows in this PR.
Both libraries need to be added to conda-forge.

@github-actions github-actions bot added the 🔮 dome Ignition Dome label Dec 24, 2020
@mabelzhang mabelzhang added the Windows Windows support label Dec 24, 2020
@codecov
Copy link

codecov bot commented Dec 24, 2020

Codecov Report

Merging #161 (194080b) into ign-gui4 (016cd32) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##           ign-gui4     #161   +/-   ##
=========================================
  Coverage     61.57%   61.57%           
=========================================
  Files            21       21           
  Lines          2790     2790           
=========================================
  Hits           1718     1718           
  Misses         1072     1072           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 016cd32...194080b. Read the comment docs.

@chapulina chapulina added the documentation Improvements or additions to documentation label Dec 28, 2020
Copy link

@JShep1 JShep1 left a comment

Choose a reason for hiding this comment

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

Small verbiage nit

1. Follow the [source install instruction](#source-install).

2. Run tests.
Before ``ign-rendering`` becomes available on conda-forge, we need to build it from source and specify the path containing ``ignition-rendering<#>-config.cmake`` and ``ignition-rendering<#>-ogre-config.cmake`` in ``CMAKE_PREFIX_PATH``. That path could be ``ign-rendering-install-path\lib\cmake``, for example.
Copy link

Choose a reason for hiding this comment

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

Suggested change
Before ``ign-rendering`` becomes available on conda-forge, we need to build it from source and specify the path containing ``ignition-rendering<#>-config.cmake`` and ``ignition-rendering<#>-ogre-config.cmake`` in ``CMAKE_PREFIX_PATH``. That path could be ``ign-rendering-install-path\lib\cmake``, for example.
As``ign-rendering`` is not available on conda-forge, we need to build it from source and specify the path containing ``ignition-rendering<#>-config.cmake`` and ``ignition-rendering<#>-ogre-config.cmake`` in ``CMAKE_PREFIX_PATH``. That path could be ``ign-rendering-install-path\lib\cmake``, for example.

@chapulina
Copy link
Contributor

Moved Documentation and Testing sections from the installation tutorial back to README - looks like a mistake that they were moved before

I think I did that on purpose on #127 because they seemed out of place in the README. A README user had no context for generating docs or running tests... But I think that you are adding enough context in this PR. Maybe we can consider moving those to their own tutorials in the future. I think the README could be more focused on highlighting features and quick onboarding, and specific development details can be left to tutorials.


Thanks for the PR. Just curious, did you try running ign gui? Does it work? How about the 3D scene plugin (ign gui -c examples/config/scene3d.config)?

@JShep1 JShep1 mentioned this pull request Jan 20, 2021
@JShep1
Copy link

JShep1 commented Jan 20, 2021

Closing to retarget at Citadel. #168

@JShep1 JShep1 closed this Jan 20, 2021
@JShep1
Copy link

JShep1 commented Jan 20, 2021

Thanks for the PR. Just curious, did you try running ign gui? Does it work? How about the 3D scene plugin (ign gui -c examples/config/scene3d.config)?

For visibility, I tested this out by attempting to run a few examples and Qt crashed every time, for what it's worth, here is the error message in case this may be relevant later:

(test_ws) C:\Users\asus\test-ws\src\ign-gui\examples\standalone\window\build\Release>window.exe
Hello, GUI!
qt.qpa.plugin: Could not find the Qt platform plugin "windows" in ""
This application failed to start because no Qt platform plugin could be initialized. Reinstalling the application may fix this problem.

Not sure if this may be a local issue or if reinstalling Qt would actually work, it could also be some sort of issue with the version of Qt that conda-forge brings in.

@JShep1 JShep1 deleted the mabelzhang/windows_install branch January 20, 2021 17:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation 🔮 dome Ignition Dome Windows Windows support
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants