mcorino / wxRuby3

Ruby Cross-Platform GUI extension
https://mcorino.github.io/wxRuby3/
MIT License
107 stars 7 forks source link

[Suggesting a new FAQ entry] Will the latest git sources of wxwidgets work with the wxRuby3 gem? #321

Closed rubyFeedback closed 2 weeks ago

rubyFeedback commented 2 weeks ago

Hey there mcorino,

I am having - or having had - a few build issues. I typically compile from source on my Linux system if that is possible.

We can fetch the latest git sources from wxWidgets via e. g.:

git clone https://github.com/wxWidgets/wxWidgets/

My next aim is to compile these.

After that step, I would like to install the wxruby3 gem, but I do not know whether it will work with the git sources. I guess the answer is "it depends", because the upstream code may change, and even though you possibly use SWIG, things may still need to be tweaked in order to work.

At any rate, though, would you consider adding a FAQ entry, stating whether this could work in PRINCIPLE, or whether we should solely confine ourselves to the latest stable releases of wxwidgets? And if so, which wxwidgets sources exactly?

A FAQ entry may help here, even if it is not 100% up to date, simply so that I know whether I should still try to use git sources, or just the tarball releases.

As I wrote initially, I sometimes have problems with wxwidgets sources, and I hope to be able to leave that behind eventually, as evidently you have already solved that issue (since you use and write code for wxwidgets, evidently).

Thank you for reading.

mcorino commented 2 weeks ago

There are weekly CI jobs for wxRuby3 running that build wxRuby3 master with wxWidgets master with the explicit aim to keep wxRuby3 as compatible as possible for wxWidgets master. Looking at the results of these builds will give you a pretty fair idea of the status and up to which wxWidgets master commit compatibility has been tested (derived from CI job run time).

Furthermore, looking at the Github Action workflow files for those CI jobs will give a pretty good idea of how building from source with wxWidgets master should be accomplished.

As for creating and installing a gem from local source the INSTALL document handles installing user supplied binary packages and rake -T and rake help will give you information about rake commands to generate gems and binary packages.

I may at some point create more extended and detailed developer information but I do not expect that to be soon.