mirror of
https://github.com/github/choosealicense.com
synced 2024-07-01 16:13:02 +02:00
![Mike Linksvayer](/assets/img/avatar_default.png)
Add missing nicknames Use SPDX ID if no customary nickname (eg GNU GPLv3) exists This ensures that a relatively compact name is always available I may be missing some obvious customary names, e.g., is "Eclipse 1.0" customary? For now I've used the SPDX ID, EPL-1.0.
53 lines
1.4 KiB
YAML
53 lines
1.4 KiB
YAML
# Each license has YAML front matter describing the license's properties.
|
|
# The available fields are:
|
|
|
|
- name: title
|
|
description: The license full name specified by http://spdx.org/licenses/
|
|
required: true
|
|
|
|
- name: nickname
|
|
description: A shorter license name; customary if applicable (e.g., GPLv3) or the SPDX ID (e.g., MPL-2.0)
|
|
required: required
|
|
|
|
- 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
|
|
|
|
- name: conditions
|
|
description: Bulleted list of required rules
|
|
required: true
|
|
|
|
- name: permissions
|
|
description: Bulleted list of permitted rules
|
|
required: true
|
|
|
|
- name: limitations
|
|
description: Bulleted list of limited rules
|
|
required: true
|
|
|
|
# Optional fields
|
|
|
|
- name: featured
|
|
description: Whether the license should be featured on the main page (defaults to false)
|
|
required: false
|
|
|
|
- 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
|
|
description: Relative path(s) to redirect to the license from, to prevent breaking old URLs
|
|
required: false
|