Skip to content

Commit

Permalink
Licensing (#36)
Browse files Browse the repository at this point in the history
  • Loading branch information
lukavdplas authored Dec 14, 2023
1 parent 50195fe commit 1a0cd38
Show file tree
Hide file tree
Showing 21 changed files with 76 additions and 75 deletions.
7 changes: 4 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

pluto_state_cache/
output/

pluto_state_cache/
output/
.vscode/
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Contributing

Are you adding a notebook to the featured notebooks? Here's what you need to know!

## Licensing

All notebooks MUST have an [OSI-approved licence](https://opensource.org/licenses/) or a [creative commons licence](https://creativecommons.org/share-your-work/cclicenses/). Whether a software licence or a creative licence is more appropriate for your notebook is up to you.

We like to use the [Unlicense](https://opensource.org/license/unlicense/) for sample notebooks, but you're free to pick a different one!

### Adding licence info to your notebook

First, specify the license in the frontmatter of your notebook. Add a `license` field with the name of your licence, and a `license_url` field with a link to the full text.

If the full text is already listed in [LICENSES](LICENSES/), you can link to that file. If not, we recommend that you add it to LICENSES yourself, so it will always be availalbe with the notebook, but you can also link to an external URL.

The Unlicense is a *public domain-equivalent* license, which means gives permission to share and reuse the code without any restrictions. There are a few other licenses like this, such as MIT No Attribution and CC-0. If you're using a license that isn't like this, add a clear paragraph in the content of your notebook to say this.
46 changes: 23 additions & 23 deletions src/basic/LICENSE → LICENSES/Unlicense
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.
In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
For more information, please refer to <https://unlicense.org>
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,23 @@ To add a notebook, simply add the file to this repository! It will be picked up
All notebook files in this repository will be rendered by PlutoSliderServer, but they will only show up in Pluto's main menu if they belong to a collection.

### License
All current Pluto sample notebooks have had the `Unlicense` license, which means that people can copy code snippets from sample notebooks and use them freely. If you also want to use the `Unlicense`, great! If not, then also write a clear paragraph stating the license in the notebook itself.

Notebooks are licensed individually. Each notebook specifies a license in the frontmatter. Here is an example of what that looks like:

```julia
### A Pluto.jl notebook ###
# v0.19.27

#> [frontmatter]
#> author_url = "https://github.com/JuliaPluto"
#> author_name = "Pluto.jl"
#> license = "Unlicense"
#> license_url = "https://github.com/JuliaPluto/featured/blob/2a6a9664e5428b37abe4957c1dca0994f4a8b7fd/LICENSES/Unlicense"
```

In this case, the notebook is authored by Pluto.jl, it is shared under the _Unlicense_, and the full text is available at the linked url. This link leads to the [LICENSES/Unlicense](/LICENSES/Unlicense) file in this repository.

If you're adding a notebook of your own, see [CONTRIBUTING](/CONTRIBUTING.md) for more information about licensing.

### Interactivity
The current *featured* system distributes notebook *statefiles*, which work the same way as Pluto's HTML export: people can read the notebook instantly, without having to wait for it to run. There is a button to *Edit and Run* a notebook that users can press to use the featured notebook as a template.
Expand Down
1 change: 1 addition & 0 deletions src/basic/Basic mathematics.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
#> order = "2"
#> tags = ["basic", "classic"]
#> license = "Unlicense"
#> license_url = "https://github.com/JuliaPluto/featured/blob/2a6a9664e5428b37abe4957c1dca0994f4a8b7fd/LICENSES/Unlicense"
#> description = "Learn mathematics in Julia using pizzas! 🍕"
#>
#> [[frontmatter.author]]
Expand Down
1 change: 1 addition & 0 deletions src/basic/Basic.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
#> tags = ["debug", "classic"]
#> author_name = "Pluto.jl"
#> license = "Unlicense"
#> license_url = "https://github.com/JuliaPluto/featured/blob/2a6a9664e5428b37abe4957c1dca0994f4a8b7fd/LICENSES/Unlicense"

using Markdown
using InteractiveUtils
Expand Down
1 change: 1 addition & 0 deletions src/basic/Getting started.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
#> order = "1"
#> tags = ["basic", "classic"]
#> license = "Unlicense"
#> license_url = "https://github.com/JuliaPluto/featured/blob/2a6a9664e5428b37abe4957c1dca0994f4a8b7fd/LICENSES/Unlicense"
#> description = "Welcome to Pluto!"
#>
#> [[frontmatter.author]]
Expand Down
1 change: 1 addition & 0 deletions src/basic/Images.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
#> tags = ["basic", "images", "markdown"]
#> description = "Learn how to import and display images!"
#> license = "Unlicense"
#> license_url = "https://github.com/JuliaPluto/featured/blob/2a6a9664e5428b37abe4957c1dca0994f4a8b7fd/LICENSES/Unlicense"
#>
#> [[frontmatter.author]]
#> name = "Pluto.jl"
Expand Down
1 change: 1 addition & 0 deletions src/basic/Markdown.jl
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
#> title = "Markdown"
#> tags = ["markdown", "basic"]
#> license = "Unlicense"
#> license_url = "https://github.com/JuliaPluto/featured/blob/2a6a9664e5428b37abe4957c1dca0994f4a8b7fd/LICENSES/Unlicense"
#> description = "Learn to write text cells with Markdown."
#>
#> [[frontmatter.author]]
Expand Down
1 change: 1 addition & 0 deletions src/basic/PlutoUI.jl.jl
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
#> title = "Interactivity"
#> tags = ["basic", "interactivity", "classic"]
#> license = "Unlicense"
#> license_url = "https://github.com/JuliaPluto/featured/blob/2a6a9664e5428b37abe4957c1dca0994f4a8b7fd/LICENSES/Unlicense"
#> description = "Slider, buttons, dropdowns, and more using PlutoUI.jl!"
#>
#> [[frontmatter.author]]
Expand Down
1 change: 1 addition & 0 deletions src/basic/Tower of Hanoi.jl
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
#> image = "https://upload.wikimedia.org/wikipedia/commons/0/07/Tower_of_Hanoi.jpeg"
#> tags = ["basic", "classic"]
#> license = "Unlicense"
#> license_url = "https://github.com/JuliaPluto/featured/blob/2a6a9664e5428b37abe4957c1dca0994f4a8b7fd/LICENSES/Unlicense"
#> description = "An interactive Julia puzzle about stacking disks."
#>
#> [[frontmatter.author]]
Expand Down
1 change: 1 addition & 0 deletions src/basic/moon.jl
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
#> tags = ["PlutoUI", "animation", "visualisation", "clock", "Unicode"]
#> description = "Making use of 🌒 emojis and PlutoUI.clock for a simple animation"
#> license = "Unlicense"
#> license_url = "https://github.com/JuliaPluto/featured/blob/2a6a9664e5428b37abe4957c1dca0994f4a8b7fd/LICENSES/Unlicense"
#> author_name = "Maanik, Boshra, Benedikt"

using Markdown
Expand Down
1 change: 1 addition & 0 deletions src/machine-learning/decision-trees.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
#> date = "2023-09-20"
#> description = "We are going to use a simple model called \"Decision Tree\" to do a classification task."
#> license = "Unlicense"
#> license_url = "https://github.com/JuliaPluto/featured/blob/2a6a9664e5428b37abe4957c1dca0994f4a8b7fd/LICENSES/Unlicense"
#>
#> [[frontmatter.author]]
#> name = "Boshra Ariguib"
Expand Down
1 change: 1 addition & 0 deletions src/math/convolution_1d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
#> date = "2023-09-20"
#> description = "Learn about the cool concept of convolution on continuous functions!"
#> license = "Unlicense"
#> license_url = "https://github.com/JuliaPluto/featured/blob/2a6a9664e5428b37abe4957c1dca0994f4a8b7fd/LICENSES/Unlicense"
#>
#> [[frontmatter.author]]
#> name = "Boshra Ariguib"
Expand Down
1 change: 1 addition & 0 deletions src/math/convolution_2d.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
#> title = "Images and Filtering"
#> tags = ["images", "filtering", "gaussian", "pixel", "convolution", "math"]
#> license = "Unlicense"
#> license_url = "https://github.com/JuliaPluto/featured/blob/2a6a9664e5428b37abe4957c1dca0994f4a8b7fd/LICENSES/Unlicense"
#> description = "Learn how convolutions are used as filters in image processing!"
#> date = "2023-07-09"
#>
Expand Down
24 changes: 0 additions & 24 deletions src/plot/LICENSE

This file was deleted.

1 change: 1 addition & 0 deletions src/plot/Plots.jl.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
#> order = "1"
#> tags = ["classic", "plotting"]
#> license = "Unlicense"
#> license_url = "https://github.com/JuliaPluto/featured/blob/2a6a9664e5428b37abe4957c1dca0994f4a8b7fd/LICENSES/Unlicense"
#> description = "An introduction to Plots.jl"
#>
#> [[frontmatter.author]]
Expand Down
1 change: 1 addition & 0 deletions src/plot/heatmap.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
#> title = "3D Graph vs Heatmap"
#> tags = ["plotting", "makie", "3D"]
#> license = "Unlicense"
#> license_url = "https://github.com/JuliaPluto/featured/blob/2a6a9664e5428b37abe4957c1dca0994f4a8b7fd/LICENSES/Unlicense"
#> description = "You can visualize 3D data with a 3D graph or a heatmap. How do they work, and what is the difference?"
#>
#> [[frontmatter.author]]
Expand Down
1 change: 1 addition & 0 deletions src/web/Interactivity with HTML.jl
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
#> title = "Interactivity with HTML"
#> tags = ["interactivity", "classic", "web"]
#> license = "Unlicense"
#> license_url = "https://github.com/JuliaPluto/featured/blob/2a6a9664e5428b37abe4957c1dca0994f4a8b7fd/LICENSES/Unlicense"
#> description = "Write your own interactive controls with HTML!"
#>
#> [[frontmatter.author]]
Expand Down
1 change: 1 addition & 0 deletions src/web/JavaScript.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
#> order = "2"
#> tags = ["javascript", "web", "classic"]
#> license = "Unlicense"
#> license_url = "https://github.com/JuliaPluto/featured/blob/2a6a9664e5428b37abe4957c1dca0994f4a8b7fd/LICENSES/Unlicense"
#> description = "Use HTML, CSS and JavaScript to make your own interactive visualizations!"
#>
#> [[frontmatter.author]]
Expand Down
24 changes: 0 additions & 24 deletions src/web/LICENSE

This file was deleted.

0 comments on commit 1a0cd38

Please sign in to comment.