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