micycle1 / PGS

Processing Geometry Suite
https://micycle1.github.io/PGS/
165 stars 13 forks source link

Readme request: link gifs to source code of each #86

Closed hamoid closed 1 year ago

hamoid commented 1 year ago

Hi! Amazing collection of algorithms!! :)

An idea: I was thinking that it would be very nice if when clicking on one of the gifs or pngs it would jump to the source code of the program that created it (instead of linking to the original image file).

Otherwise one may see something they would like to play with, but how to find the related code?

Cheers!

micycle1 commented 1 year ago

Thank you for sharing your suggestion.

This idea has actually been raised before, specifically in #44. In my response to that, I mentioned that while it could be useful, it might be considered overkill. My expectation is that the methods showcased in the GIFs should be easily discoverable within the codebase, usually by referring to the class relevant to section the GIF belongs to in the README file. Further, I've put a lot of effort into the javadocs, which should hopefully ease usage.

hamoid commented 1 year ago

Ok! :+1: I close this issue then :-)