sudara / awesome-juce

A curated list of JUCE modules, templates, plugins, oh my!
MIT License
815 stars 39 forks source link

`squarepine_core` things #7

Closed jrlanglois closed 2 years ago

jrlanglois commented 2 years ago

First - thanks for such a cool initiative! The list is excitingly extensive and well documented.


As the author - I wanted to mention that there's an issue with the license with the squarepine_core item in your list: it's not custom, but ISC. You can find it here: https://github.com/SquarePine/squarepine_core/blob/main/LICENSE.md .

More information about this license can be found here: https://www.isc.org/licenses/ .

It's worth noting that 4 modules from JUCE itself are ISC licensed: juce_audio_basics, juce_audio_devices, juce_core and juce_events. You can find the official details here: https://github.com/juce-framework/JUCE/blob/master/LICENSE.md .

License aside, it should be noted that the modules provide an assortment of other functionality than mentioned: from audio effects and audio processor management/creation, network connectivity checking, maths, among others. Feel free to summarise as you will - that information is lost in the present description though.

sudara commented 2 years ago

Hey Joël, nice to see you here! Thanks for the nice words and opening an issue.

it's not custom, but ISC

Yeah, this is annoying. The README is generated from the GitHub API so I can do things like check for existence, update stars, licenses, last updated at, etc. Currently the GitHub API returns "NOASSERTION" for your repository, I believe because ISC isn't an option in GitHub's license picker. It seems that they use a fairly short list to keep things easier for people getting started...

I'm not sure how to resolve outside of including licenses in our data file, which would then make everything manual and prevent it from picking up license changes, etc. For now, I switched the terminology to "Other" rather than "Custom" (which sounds like you might have hand rolled it) but maybe "see repo" would work better?...

the modules provide an assortment of other functionality than mentioned

Yeah, I saw that! I was happy to find your repo, so many goodies in there!

Yes, this a problem for every repo under "Module Collections & Libraries." They are all monorepos from individuals/companies that have bundled their modules into 1 place. It's easier to maintain and share between internal projects that way. However, it's also harder for external devs to understand which modules are "mature" and full featured vs. experimental or very specific to that company in feature set. People are also warier of including a dependency as an actual module if they are just using 2% of the code (Often people will pull the .h/.cpp they want, which is a bummer, as it sidesteps potential collaboration, updates, etc).

Anyway! Got distracted here. Monorepo pros and cons aside, for awesome-juce, it's pretty tough to summarize these monorepos in one line outside of "a large collection of modules!"

I tried to highlight a few unique things you offered (different from the other collections). We're extremely space limited so that the list remains scannable but I'm more than happy to swap out the description with anything else that's as concise!

jrlanglois commented 2 years ago

For now, I switched the terminology to "Other" rather than "Custom" (which sounds like you might have hand rolled it) but maybe "see repo" would work better?...

I think "Other" is a decent compromise. I didn't dig too deeply into this repository therefore missed the fact that the README.md is auto-populated; thanks for explaining the situation with GitHub and its license options. I definitely wanted to avoid the situation looking as if I wrote my own license! (Though I think a take on "beerware" may be on the horizon as any license is just too serious for the time I have...)

We're extremely space limited so that the list remains scannable but I'm more than happy to swap out the description with anything else that's as concise!

Fair enough! I haven't cycles to give this proper attention so let's just call it fine for now. 🙂

Cheers!

sudara commented 2 years ago

Though I think a take on "beerware" may be on the horizon as any license is just too serious for the time I have...

Hahah, yeah I hear that!!

Fair enough! I haven't cycles to give this proper attention so let's just call it fine for now. 🙂

I'll probably do another round of going through all of them sometime shortly, as a lot of the descriptions were very superficial takes!

Thanks Joël!