2015-08-22 21:25:16 +02:00
# Each license has YAML front matter describing the license's properties.
# The available fields are:
- name : title
2018-05-22 22:39:44 +02:00
description : The license full name specified by https://spdx.org/licenses/
2015-08-22 21:25:16 +02:00
required : true
2016-05-24 23:21:13 +02:00
- name : spdx-id
2018-05-22 22:39:44 +02:00
description : Short identifier specified by https://spdx.org/licenses/
2017-07-25 17:22:05 +02:00
required : true
2016-05-24 21:21:29 +02:00
2015-08-22 21:25:16 +02:00
- name : description
description : A human-readable description of the license
required : true
- name : how
description : Instructions on how to implement the license
required : true
2016-03-01 22:33:15 +01:00
- name : conditions
2015-08-22 21:25:16 +02:00
description : Bulleted list of required rules
required : true
2016-03-01 22:33:15 +01:00
- name : permissions
2015-08-22 21:25:16 +02:00
description : Bulleted list of permitted rules
required : true
2016-03-01 22:33:15 +01:00
- name : limitations
description : Bulleted list of limited rules
2015-08-22 21:25:16 +02:00
required : true
2017-05-30 23:17:13 +02:00
- 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
2015-08-22 21:25:16 +02:00
# Optional fields
2016-04-26 21:22:15 +02:00
- name : featured
description : Whether the license should be featured on the main page (defaults to false)
required : false
2016-06-14 19:35:44 +02:00
- name : hidden
2018-05-22 22:39:44 +02:00
description : Whether the license is neither [popular](https://opensource.org/licenses) nor fills out the [spectrum of licenses](https://choosealicense.com/licenses/) from strongly conditional to unconditional (defaults to true)
2016-06-14 19:35:44 +02:00
required : false
2016-05-24 23:21:13 +02:00
- name : nickname
description : Customary short name if applicable (e.g, GPLv3)
required : false
2015-08-22 21:25:16 +02:00
- name : note
description : Additional information about the licenses
required : false
- name : redirect_from
2016-02-03 01:10:39 +01:00
description : Relative path(s) to redirect to the license from, to prevent breaking old URLs
2015-08-22 21:25:16 +02:00
required : false