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 snippets in README.md and myst.yml #10

Merged
merged 7 commits into from
May 1, 2024
Merged

Add license snippets in README.md and myst.yml #10

merged 7 commits into from
May 1, 2024

Conversation

santisoler
Copy link
Member

@santisoler santisoler commented Jan 12, 2024

Add CC-BY and MIT licenses snippets in the README.md and configure them for the Myst website in myst.yml. Add CC-BY license text in a new LICENSE-CC-BY file.

Fixes #7

For reference, the licenses that can be set in the Myst configuration file are listed here: https://mystmd.org/guide/frontmatter#licenses


All code and text in this repository is free software: you can redistribute it
and/or modify it under the terms of the MIT License.
A copy of this license is provided in [LICENSE](LICENSE).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we also mention that content is creative commons (CC-BY-4.0)? There is a lot of text (or maybe we can simply include this in the footer of the website?)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Totally. I think we should use CC-BY for text and figures, except where explicitly stated.

Does it make sense to use CC-BY as the license in the Myst configuration then?

myst.yml Outdated Show resolved Hide resolved
@santisoler
Copy link
Member Author

I think it's easier to just use CC-BY for the whole repo, than specifying MIT for code and CC-BY for text and figures.

@dccowan, since you authored most of the content in this repo, do you agree with licensing it under CC-BY? Feel free to comment here or just merge the PR if you agree.

myst.yml Outdated
@@ -2,8 +2,9 @@
version: 1
project:
title: SimPEG User Tutorials
# github:
# description:
license: CC-BY-4.0
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
license: CC-BY-4.0
licence:
content: CC-BY-4.0
code: MIT

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just noticed that we can set two licenses through Myst. Thanks for the comment @lheagy

@santisoler
Copy link
Member Author

I'm merging this. In case we change our minds on the licenses, we can discuss it in future issues/prs.

@santisoler santisoler changed the title Add license snippet in README.md and myst.yml Add license snippets in README.md and myst.yml May 1, 2024
@santisoler santisoler merged commit 07bd211 into main May 1, 2024
2 checks passed
@santisoler santisoler deleted the license branch May 1, 2024 16:21
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.

Add LICENSE to the repository
3 participants