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

Provide a place for asset licenses #182

Open
benfrankel opened this issue Jul 20, 2024 · 2 comments
Open

Provide a place for asset licenses #182

benfrankel opened this issue Jul 20, 2024 · 2 comments
Labels
enhancement New feature or request question Further information is requested
Milestone

Comments

@benfrankel
Copy link
Collaborator

The current LICENSE files apply to the template's source code but not its assets. The assets are credited in the README.md and the game code, but users will likely delete both of those places.

Placing asset licenses in assets/ is an option, but then the release workflows will need to know to delete license files from assets/. Maybe assets/licenses/ would make this easier?

@benfrankel benfrankel added enhancement New feature or request question Further information is requested labels Jul 20, 2024
@benfrankel benfrankel added this to the Bevy Jam 6 milestone Jul 20, 2024
@benfrankel
Copy link
Collaborator Author

benfrankel commented Jul 20, 2024

Including a limited version of the README.md in the cargo-generate branch that only includes the # Credits section is another option, and the user can update that section accordingly. That doesn't provide a place for license files, but it does provide a place for credit + mentioning the name of the license, which may be sufficient for some permissive licenses.

@Sapein
Copy link
Collaborator

Sapein commented Jul 20, 2024

Including a limited version of the README.md in the cargo-generate branch that only includes the # Credits section is another option, and the user can update that section accordingly. That doesn't provide a place for license files, but it does provide a place for credit + mentioning the name of the license, which may be sufficient for some permissive licenses.

For cargo-generate we can provide a (for lack of better term) stub README.md file. This file would be used instead of the in-template README.md file, and we can template it as well. If we did this, it would be done using the same systems as asking for which license the user wants to use (that is hooks).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants