1
0
mirror of https://github.com/github/choosealicense.com synced 2024-12-22 04:40:09 +01:00

make explicit in docs what I was about to leave as pull request desc

This commit is contained in:
Mike Linksvayer 2016-06-30 09:47:28 -07:00
parent 69095b6f93
commit 675309ad24
2 changed files with 2 additions and 2 deletions

View File

@ -54,7 +54,7 @@ Licenses sit in the `/_licenses` folder. Each license has YAML front matter desc
* `hidden` - Whether the license is hidden from the license list (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 and a link to each of their LICENSE files in the form of `project_name: "url"`
* `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

View File

@ -52,7 +52,7 @@
required: false
- name: using
description: 'A list of up to 3 notable projects using the license and a link to each of their LICENSE files in the form of `project_name: "url"`'
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