Skip to content

Commit

Permalink
License the docs itself under CC BY-NC-SA 4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
ItsDrike committed Aug 6, 2024
1 parent b3b04bb commit e665de7
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 3 deletions.
23 changes: 23 additions & 0 deletions docs/LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Documentation License

This documentation itself does NOT follow the primary project license!

Instead, it follows a Creative Commons license: <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/">CC BY-NC-SA 4.0</a> <img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/nc.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/sa.svg?ref=chooser-v1" alt="">

## Attribution

If you need a copyright header for proper attribution, you can use:

<a href="https://py-mine.github.io/mcproto">Mcproto Documentation</a> &copy; 2024 by <a href="mailto:[email protected]">ItsDrike</a>

In HTML:

```html
<a href="https://py-mine.github.io/mcproto">Mcproto Documentation</a> &copy; 2024 by <a href="mailto:[email protected]">ItsDrike</a>
```

If you also need the license identifier, use the following:

```html
<a href="https://creativecommons.org/licenses/by-nc-sa/4.0/">CC BY-NC-SA 4.0</a> <img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/nc.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/sa.svg?ref=chooser-v1" alt="">
```
30 changes: 28 additions & 2 deletions docs/community/license.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -12,8 +12,34 @@ LGPL as well.
--8<-- "LICENSE.txt"
```

## This documentation

This documentation itself follows a Creative Commons license: <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/">CC BY-NC-SA 4.0</a> <img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/nc.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/sa.svg?ref=chooser-v1" alt="">

!!! tip

If you need a copyright header for proper attribution, you can use:

=== "Rendered"

<a href="https://py-mine.github.io/mcproto">Mcproto Documentation</a> &copy; 2024 by <a href="mailto:[email protected]">ItsDrike</a>

=== "HTML"

```html
<a href="https://py-mine.github.io/mcproto">Mcproto Documentation</a> &copy; 2024 by <a href="mailto:[email protected]">ItsDrike</a>
```

If you also need the license identifier, use the following:

```html
<a href="https://creativecommons.org/licenses/by-nc-sa/4.0/">CC BY-NC-SA 4.0</a> <img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/nc.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/sa.svg?ref=chooser-v1" alt="">
```

## 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"

Expand Down
6 changes: 5 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit e665de7

Please sign in to comment.