diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2c309e1..6ee9bd9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,6 +20,7 @@ Choosealicense.com is intended to demystify license choices, not present or cata * [GNU's list of free licenses](https://www.gnu.org/licenses/license-list.en.html) (*note: the license must be listed in one of the three "free" categories*) * [Open Definition's list of conformant licenses](http://opendefinition.org/licenses/) (non-code) 3. A [GitHub code search](https://github.com/search?q=MIT+filename%3ALICENSE&type=Code) must reveal at least *1,000* public repositories using the license +4. 3 notable projects using the license with straightforward LICENSE files which serve as examples newcomers can follow and that could be detected by [licensee](https://github.com/benbalter/licensee) if it knew about the license If your proposed license meets the above criteria, here's a few other things to keep in mind as you propose the license's addition: diff --git a/README.md b/README.md index d065437..999e90f 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,7 @@ Licenses sit in the `/_licenses` folder. Each license has YAML front matter desc * `source` - The URL to the license source text * `description` - A human-readable description of the license * `how` - Instructions on how to implement the license +* `using` - A list of 3 notable projects using the license with straightforward LICENSE files which serve as examples newcomers can follow and that can be detected by [licensee](https://github.com/benbalter/licensee) in the form of `project_name: license_file_url` * `permissions` - Bulleted list of permission rules * `conditions` - Bulleted list of condition rules * `limitations` - Bulleted list of limitation rules @@ -54,7 +55,6 @@ Licenses sit in the `/_licenses` folder. Each license has YAML front matter desc * `hidden` - Whether the license is neither [popular](https://opensource.org/licenses) nor fills out the [spectrum of licenses](http://choosealicense.com/licenses/) from strongly conditional to unconditional (defaults to true) * `nickname` - Customary short name if applicable (e.g, GPLv3) * `note` - Additional information about the licenses -* `using` - A list of up to 3 notable projects using the license with straightforward LICENSE files which serve as examples newcomers can follow and that can be detected by [licensee](https://github.com/benbalter/licensee) in the form of `project_name: license_file_url` * `redirect_from` - Relative path(s) to redirect to the license from, to prevent breaking old URLs ### Auto-populated fields diff --git a/_data/meta.yml b/_data/meta.yml index fc97bd0..1668c04 100644 --- a/_data/meta.yml +++ b/_data/meta.yml @@ -33,6 +33,10 @@ description: Bulleted list of limited rules required: true +- name: using + description: 'A list of 3 notable projects using the license with straightforward LICENSE files which serve as examples newcomers can follow and that can be detected by [licensee](https://github.com/benbalter/licensee) in the form of `project_name: license_file_url`' + required: true + # Optional fields - name: featured @@ -51,10 +55,6 @@ description: Additional information about the licenses required: false -- name: using - description: 'A list of up to 3 notable projects using the license with straightforward LICENSE files which serve as examples newcomers can follow and that can be detected by [licensee](https://github.com/benbalter/licensee) in the form of `project_name: license_file_url`' - required: false - - name: redirect_from description: Relative path(s) to redirect to the license from, to prevent breaking old URLs required: false diff --git a/_licenses/afl-3.0.txt b/_licenses/afl-3.0.txt index 07754dd..9fbfc86 100644 --- a/_licenses/afl-3.0.txt +++ b/_licenses/afl-3.0.txt @@ -7,6 +7,8 @@ description: The Academic Free License is a variant of the Open Software License how: Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Files licensed under AFL 3.0 must also include the notice "Licensed under the Academic Free License version 3.0" adjacent to the copyright notice. +using: + permissions: - commercial-use - modifications diff --git a/_licenses/agpl-3.0.txt b/_licenses/agpl-3.0.txt index fe61572..6705c36 100644 --- a/_licenses/agpl-3.0.txt +++ b/_licenses/agpl-3.0.txt @@ -12,6 +12,8 @@ how: Create a text file (typically named LICENSE or LICENSE.txt) in the root of note: The Free Software Foundation recommends taking the additional step of adding a boilerplate notice to the top of each file. The boilerplate can be found at the end of the license. +using: + permissions: - commercial-use - modifications diff --git a/_licenses/artistic-2.0.txt b/_licenses/artistic-2.0.txt index 755a4af..8b84ce1 100644 --- a/_licenses/artistic-2.0.txt +++ b/_licenses/artistic-2.0.txt @@ -8,6 +8,8 @@ description: Heavily favored by the Perl community, the Artistic license require how: Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code, and copy the text of the license into the file. Do not replace the copyright notice (year, author), which refers to the license itself, not the licensed project. +using: + permissions: - commercial-use - modifications diff --git a/_licenses/bsd-2-clause.txt b/_licenses/bsd-2-clause.txt index 73de9c3..597a03a 100644 --- a/_licenses/bsd-2-clause.txt +++ b/_licenses/bsd-2-clause.txt @@ -9,6 +9,8 @@ description: A permissive license that comes in two variants, the BSD 3-Clause Lic how: Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders. Replace [project] with the project organization, if any, that sponsors this work. +using: + permissions: - commercial-use - modifications diff --git a/_licenses/bsd-3-clause.txt b/_licenses/bsd-3-clause.txt index f74002d..71f9235 100644 --- a/_licenses/bsd-3-clause.txt +++ b/_licenses/bsd-3-clause.txt @@ -8,6 +8,8 @@ description: A permissive license similar to the found on their website. +using: + permissions: - commercial-use - modifications diff --git a/_licenses/eupl-1.1.txt b/_licenses/eupl-1.1.txt index 81fb2b2..da10315 100644 --- a/_licenses/eupl-1.1.txt +++ b/_licenses/eupl-1.1.txt @@ -10,6 +10,8 @@ how: Create a text file (typically named COPYING or LICENCE.txt) in the root of note: The European Commission recommends taking the additional step of adding a [boilerplate notice](https://joinup.ec.europa.eu/sites/default/files/ckeditor_files/files/EUPL%201_1%20Guidelines%20EN%20Joinup.pdf#page=17) to the top of each file. +using: + permissions: - commercial-use - modifications diff --git a/_licenses/lgpl-2.1.txt b/_licenses/lgpl-2.1.txt index d1224d0..81c218e 100644 --- a/_licenses/lgpl-2.1.txt +++ b/_licenses/lgpl-2.1.txt @@ -12,6 +12,8 @@ how: Create a text file (typically named LICENSE or LICENSE.txt) in the root of note: The Free Software Foundation recommends taking the additional step of adding a boilerplate notice to the top of each file. The boilerplate can be found at the end of the license. +using: + permissions: - commercial-use - modifications diff --git a/_licenses/lgpl-3.0.txt b/_licenses/lgpl-3.0.txt index cea10cb..4006367 100644 --- a/_licenses/lgpl-3.0.txt +++ b/_licenses/lgpl-3.0.txt @@ -12,6 +12,8 @@ how: This license is an additional set of permissions to the GNU GPLv3 license. Insert the word “Lesser” before “General” in all three places in the boilerplate notice to make sure that you refer to the GNU LGPLv3 and not the GNU GPLv3. +using: + permissions: - commercial-use - modifications diff --git a/_licenses/lppl-1.3c.txt b/_licenses/lppl-1.3c.txt index 42d45c4..984bf3b 100644 --- a/_licenses/lppl-1.3c.txt +++ b/_licenses/lppl-1.3c.txt @@ -9,6 +9,8 @@ how: To use this license, place in each of the components of your work both an e note: An example boilerplate and more information about how to use the license can be found at the end of the license. +using: + permissions: - commercial-use - modifications diff --git a/_licenses/ms-pl.txt b/_licenses/ms-pl.txt index dc1485a..5c26163 100644 --- a/_licenses/ms-pl.txt +++ b/_licenses/ms-pl.txt @@ -7,6 +7,8 @@ description: An open source license with a patent grant. how: Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. +using: + permissions: - commercial-use - modifications diff --git a/_licenses/ms-rl.txt b/_licenses/ms-rl.txt index 18ab1ca..a932c98 100644 --- a/_licenses/ms-rl.txt +++ b/_licenses/ms-rl.txt @@ -7,6 +7,8 @@ description: An open source license with a patent grant similar to the