-
Notifications
You must be signed in to change notification settings - Fork 103
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rename license files to standardised names #89
base: main
Are you sure you want to change the base?
Conversation
I just realised that this is licensed under both the MIT and the Apache 2.0 license... I guess this complicates things a bit. Maybe there should be a third file |
The dilemma of two license choices can be solved with the disjunctive "OR" operator defined by SPDX. See https://spdx.github.io/spdx-spec/v3.0.1/annexes/spdx-license-expressions/
According to the SPDX specification on composite license expressions you just have to put an "OR" keyword between the license options. |
The README.md refers to these files as well. ("See MIT or APACHE2.0 for more information on each specific licence.") |
Right, I'll do that |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FYI our main repo uses the same licences and GitHub detects them correctly.
We should have it done consistently.
https://github.com/rp-rs/rp-hal
Yeah, since the readme mentions the dual license with a proper |
Summary of all my comments:
Saving the licenses in files named
MIT
andAPACHE2.0
1 (which is not a valid identifier anyway) prevents tools like VSCode and GitHub (see GitHub docs) as well as users to recognize them as a license file at a glance. The convention is to name themLICENSE
, or in the case of multiple files,LICENSE-<name>
2. There's also a standardized notation for the case of choice between multiple licenses.3Footnotes
See https://github.com/rp-rs/rp2040-project-template/pull/89#issuecomment-2471463168 ↩
See https://github.com/rp-rs/rp2040-project-template/pull/89/commits/08978253530ed005f7890dc60551f8d5c6e5a712 ↩
See https://github.com/rp-rs/rp2040-project-template/pull/89#issuecomment-2471480496 ↩