From e665de7a022b9525b67f6bc759d4698c5d786878 Mon Sep 17 00:00:00 2001 From: ItsDrike Date: Tue, 6 Aug 2024 20:12:32 +0200 Subject: [PATCH] License the docs itself under CC BY-NC-SA 4.0 --- docs/LICENSE.md | 23 +++++++++++++++++++++++ docs/community/license.md | 30 ++++++++++++++++++++++++++++-- mkdocs.yml | 6 +++++- 3 files changed, 56 insertions(+), 3 deletions(-) create mode 100644 docs/LICENSE.md diff --git a/docs/LICENSE.md b/docs/LICENSE.md new file mode 100644 index 00000000..ed1add7a --- /dev/null +++ b/docs/LICENSE.md @@ -0,0 +1,23 @@ +# Documentation License + +This documentation itself does NOT follow the primary project license! + +Instead, it follows a Creative Commons license: CC BY-NC-SA 4.0 + +## Attribution + +If you need a copyright header for proper attribution, you can use: + +Mcproto Documentation © 2024 by ItsDrike + +In HTML: + +```html +Mcproto Documentation © 2024 by ItsDrike +``` + +If you also need the license identifier, use the following: + +```html +CC BY-NC-SA 4.0 +``` diff --git a/docs/community/license.md b/docs/community/license.md index 971e2a34..d18e3951 100644 --- a/docs/community/license.md +++ b/docs/community/license.md @@ -1,6 +1,6 @@ # License -This project is licensed under the **GNU Lesser General Public License** (LGPL) version 3. +This project's source code is licensed under the **GNU Lesser General Public License** (LGPL) version 3. The LGPL license allows you to use mcproto as a library pretty much in any code-base, including in proprietary code-bases. However, if you wish to make a derivative project to mcproto itself, such a project will need to be licensed under @@ -12,8 +12,34 @@ LGPL as well. --8<-- "LICENSE.txt" ``` +## This documentation + +This documentation itself follows a Creative Commons license: CC BY-NC-SA 4.0 + +!!! tip + + If you need a copyright header for proper attribution, you can use: + + === "Rendered" + + Mcproto Documentation © 2024 by ItsDrike + + === "HTML" + + ```html + Mcproto Documentation © 2024 by ItsDrike + ``` + + If you also need the license identifier, use the following: + + ```html + CC BY-NC-SA 4.0 + ``` + +## Differently licensed parts + Some parts of the project follow a different license. See the `LICENSE-THIRD-PARTY.txt` file, which lists all of these -parts and their respective licenses +parts and their respective licenses. ??? example "Full LICENSE-THIRD-PARTY text" diff --git a/mkdocs.yml b/mkdocs.yml index ea0ae5a3..5521e103 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,7 +4,11 @@ site_url: https://py-mine.github.io/mcproto repo_url: https://github.com/py-mine/mcproto repo_name: py-mine/mcproto -watch: [LICENSE.txt, LICENSE-THIRD-PARTY.txt, ATTRIBUTION.md, CHANGELOG.md, changes] +watch: + [LICENSE.txt, LICENSE-THIRD-PARTY.txt, ATTRIBUTION.md, CHANGELOG.md, changes] + +exclude_docs: | + LICENSE.md nav: - Home: index.md