ahlstromcj / sequencer64

A major reboot of Seq24. Current release 0.97.0 (2021-05-13), native JACK MIDI, Song recording, playlists, and a Windows/Qt version. For fresher code, see the Seq66 project. Note that trigger and mute-group-in-MIDI-file formats have evolved! Back up your work!
GNU Affero General Public License v3.0
235 stars 29 forks source link

[REQ] add a (GH-compliant) license file #224

Closed MarcoRavich closed 2 weeks ago

MarcoRavich commented 1 month ago

Hi there, 1st of all thanks for this awesome work !

Since we've 'doxed' it in our HyMPS project (under AUDIO section \ Sequencers page \ Audio), can you please add a GH-compliant license file for it ?

As you know, expliciting licensing terms is extremely important to let anyone better/faster understand how to reuse/adapt/modify sources (and not only) in other open projects and vice-versa.

Although it may sounds like a minor aspect, license file omission obviously causes an inconsistent generation of the relative badge too:

(badge-generator URL: https://badgen.net/github/license/ahlstromcj/sequencer64)

You can easily set a standardized one through the GH's license wizard tool.

Last but not least, let us know how we could improve - in your opinion - our categorizations and links to resources in order to favor collaboration between developers (and therefore evolution) of listed projects.

Hope that helps/inspires !

ahlstromcj commented 1 month ago

Actually Sequencer64 is not really active. It's been far surpassed by my Seq66 project. I will look into gh licensing for both soon.

Message ID: @.***>

MarcoRavich commented 1 month ago

Thanks a lot (Seq66 just added to the list) !

However, to make GH recognize multiple licenses, you have to configure them as done in FLAC or FFMPEG repositories: https://github.com/xiph/flac https://github.com/FFmpeg/FFmpeg

Hope that helps !

ahlstromcj commented 1 month ago

Does that means simply renaming them to COPYING.FDL etc.?

I'm trying to download a license using "gh license gpl-3.0" (command-line) but am getting authentication errors even after runnining "gh configure".

MarcoRavich commented 1 month ago

My suggestion is to restart from scratch:

  1. delete all license files;
  2. recreate each license file, by naming LICENSE.type (e.g. LICENSE.GPL, LICENSE.LGPL, LICENSE.FDL, etc);
  3. Paste licenses texts GH expects inside and be sure to modify only allowed rows (you can also "steal" licenses files from FLAC/FFMPEG repos and mod only that rows);
  4. Check if GH recognizes all licenses (if not, that license will be listed as "License").

Hope that helps.

ahlstromcj commented 1 month ago

Thanks! More questions. What is GH then? Is that the badge-gen site? Do I just drag-and-drop the licenses files on it? All I see is a blank page.

What do you mean by "rows"?

Sorry for these ignorant questions....

MarcoRavich commented 1 month ago

What is GH then?

Ehmmm GitHub...

Is that the badge-gen site?

No, we do use 2 different badge generators services: Shields.io and Badgen.

They have specific GitHub dynamic badges.

Do I just drag-and-drop the licenses files on it?

No, they do need just the repo user/name. Examples: GitHub followers = https://img.shields.io/github/followers/ahlstromcj GitHub forks = https://img.shields.io/github/forks/ahlstromcj/seq66 GitHub last-commit = https://badgen.net/github/last-commit//ahlstromcj/seq66

All I see is a blank page. What do you mean by "rows"?

You cannot customize the license file text at all, but just some specific rows. Check out this one, for example: https://github.com/xiph/flac/blob/master/COPYING.FDL

Sorry for these ignorant questions....

Don't worry, we're here to help open source devs !

ahlstromcj commented 1 month ago

Well, I got the text from the shields boilerplate site and made 3 LICENSE.* files from them; they're the same text as in xiph/flac. I committed them and pushed.

They're in the portfix branch now, and I when I switch to that branch in the browser I see three links called "LICENSE".

But in xiph/flac, the buttons/links have more descriptive names rather than the same name for each.

Where did I go wrong? Thanks!

MarcoRavich commented 1 month ago

...then try to rename files again like in FFMPEG repo (that has license version too in file extension).

It could be also possible that GH requires some time so recognize renamed licenses files.

ahlstromcj commented 1 month ago

I think I figured out what is needed while using the Insights / Community Standards / License link to add a LICENSE to Sequencer64.

I will try to change the labels once I merge the branch to "master".

MarcoRavich commented 1 month ago

Yes, S64 repo generates the correct license badge now: https://badgen.net/github/license/ahlstromcj/sequencer64