about summary refs log tree commit diff stats
path: root/README.md
blob: e48d5461db78933d4bf9a89706e347aed74e870b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# licenser: plop a license in there

Are you tired of copying and pasting licenses into your new projects?
Do you always forget what the dang github api thing is?
Or I don't know, have some other reason why doing licenses is hard?

Well now you don't have to worry!
Just run `licenser` in your new repo and BLAMMO!
Done.

## Usage

literally taken from `licenser -h`

```
licenser: plop a license in your project

usage:	licenser [-h|-m|-M]
	licenser [-f] [-q] [-y YEAR] [-a AUTHOR] [-e EMAIL] 
	      [-l LANG] [-o FILE] [LICENSE]
flags:
	-h	show this help and exit
	-m	list available licenses and exit
	-M	list licenses, disregarding cached manifest
	-f	overwrite existing license
	-q	quiet: don't log anything
options:
	-y YEAR		set copyright date(s) to YEAR.
			default: $(date +%Y).
			this option accepts arbitrary input.
	-a AUTHOR	set copyright holder(s) to AUTHOR.
			default:
				- git config --get user.name
				- getent password $USER
				- $USER
	-e EMAIL	set AUTHOR's email address to EMAIL.
			default:
				- git config --get user.email
				- [blank]
	-l LANG		set license language to LANG.
			default: 'en' (subject to change)
	-o FILE		set output file to FILE.
			default: LICENSE in $PWD
parameters:
	LICENSE		which license to use.
			default: $LICENSER_LICENSE, which
			defaults to MIT.
```

## License source

As of v0.2, `licenser` gets its licenses from
[another repo](https://git.sr.ht/~acdw/licenser-licenses),
to streamline additions to available licenses.
If you have spotty internet connection or want to use your own license source,
you can change the environment variable `$LICENSER_SOURCE`.

For v0.3, I want to add a configuration file to take care of these kinds of
configurations.

## Contributing

Send me a request for another license or a pull-thingy
through [the mailing list](~acdw/licenser@lists.sr.ht).

Or, look at the [roadmap](https://todo.sr.ht/~acdw/licenser).

## License

MIT, baby.


## Author

Case Duckworth <acdw@acdw.net> wrote this.
He did not look around for existing solutions.