In the
official getting started guide, I see that Quil v3.1.0 is used. But there is no mention of which version of Java to use to avoid OS-specific issues, P2D/P3D rendering issues, etc.
There are several comments in issues in GitHub which recommend using Quil 4.0.0-SNAPSHOT or 4.0.0-SNAPSHOT-1.
Here,
here and
here are some examples. But those suggestions rarely suggest which versions of Java to use.
I have read through most of the GitHub issue comments which discuss using different versions of Quil and Java to get around certain issues. And I have read through the Quil documentation, trying to find officially recommended versions for Quil and Java. But I have not been able to find that information in the documentation. RELEASE-NOTES.md does contain some mentioned of Java compatibility issues and fixes.
It would be super helpful for newcomers if the README.md had a table, to show what are the officially tested/recommended and supported versions of Quil + Java combinations. I think this would eliminate a lot of confusion, and make the experience smoother.
Also, I understand that it is difficult to test all combinations of operating systems/versions, Java versions, Processing versions, and Quil versions. And even the user's graphics card might make trigger some rare issues. Perhaps it would be a good idea to create some automated tests or sketches for manual testing, so that users and community members such as myself could more easily test on our systems and report bugs with a higher degree of accuracy.
And thanks for all the great work you're doing with Quil!