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
|
2016-05-24 21:21:29 +02:00
|
|
|
description: The license full name specified by http://spdx.org/licenses/
|
2015-08-22 21:25:16 +02:00
|
|
|
required: true
|
|
|
|
|
2016-05-24 21:21:29 +02:00
|
|
|
- name: nickname
|
|
|
|
description: A shorter license name; customary if applicable (e.g., GPLv3) or the SPDX ID (e.g., MPL-2.0)
|
|
|
|
required: required
|
|
|
|
|
2015-08-22 21:25:16 +02: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 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
|
|
|
|
|
|
|
|
# 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
|
|
|
|
|
2015-08-22 21:25:16 +02:00
|
|
|
- name: note
|
|
|
|
description: Additional information about the licenses
|
|
|
|
required: false
|
|
|
|
|
|
|
|
- name: using
|
|
|
|
description: 'A list of notable projects using the license in the form of `project_name: "url"`'
|
|
|
|
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
|