Skip to content
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

Add license = "MIT" field to Cargo.toml #464

Merged
merged 1 commit into from
Oct 16, 2023

Conversation

LikeLakers2
Copy link
Contributor

@LikeLakers2 LikeLakers2 commented Sep 1, 2023

This PR adds a license = "MIT" field to Cargo.toml.

This does not change the license of bevy_ecs_tilemap - it is still the MIT license. However, this allows tools (such as crates.io or cargo-license) to better recognize the license used by this crate.

For example, currently crates.io cites this crate has having a non-standard license, as only license-file is specified and crates.io cannot detect if the file is indeed the MIT license. With this change, crates.io can (upon the next published update) detect that the license is indeed the MIT license.


P.S. I left the license-file field in because, according to the manifest format documentation for the include field:

The following files are always included:

and it is not otherwise clear if LICENSE would be included without some additional tinkering to Cargo.toml. As I am not sure if it's desired for the LICENSE file to be distributed, and it's unlikely that having both license and license-file would be considered an issue, I am taking the safe route - I am leaving the license-file field in.

@StarArawn StarArawn merged commit ac22adb into StarArawn:main Oct 16, 2023
@LikeLakers2
Copy link
Contributor Author

@StarArawn Thanks! Do note that crates.io will only see this field when you next publish the crate - it doesn't read the field from the github repository.

@LikeLakers2 LikeLakers2 deleted the add-license-to-cargo-toml branch October 16, 2023 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants