glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2024-12-27 14:57:06 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix cobra command README (#1106)

Browse source 
Describes the behavior of custom LICENSE generation using properties in
~/.cobra.yml
This commit is contained in:
Warren Fernandes 2020-04-28 11:49:46 -06:00 committed by GitHub
parent 11ba63fc3b
commit 44d55fb4d3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
cobra/README.md
View file

@ -88,12 +88,17 @@ author: Steve Francia <spf@spf13.com>
license: MIT
```
You can also use built-in licenses. For example, **GPLv2**, **GPLv3**, **LGPL**,
**AGPL**, **MIT**, **2-Clause BSD** or **3-Clause BSD**.
You can specify no license by setting `license` to `none` or you can specify
a custom license:
```yaml
author: Steve Francia <spf@spf13.com>
year: 2020
license:
header: This file is part of {{ .appName }}.
header: This file is part of CLI application foo.
text: |
{{ .copyright }}
@ -102,5 +107,23 @@ license:
master my life.
```
You can also use built-in licenses. For example, **GPLv2**, **GPLv3**, **LGPL**,
**AGPL**, **MIT**, **2-Clause BSD** or **3-Clause BSD**.
In the above custom license configuration the `copyright` line in the License
text is generated from the `author` and `year` properties. The content of the
`LICENSE` file is
```
Copyright © 2020 Steve Francia <spf@spf13.com>
This is my license. There are many like it, but this one is mine.
My license is my best friend. It is my life. I must master it as I must
master my life.
```
The `header` property is used as the license header files. No interpolation is
done. This is the example of the go file header.
```
/*
Copyright © 2020 Steve Francia <spf@spf13.com>
This file is part of CLI application foo.
*/
```