about summary refs log tree commit diff stats
diff options
context:
space:
mode:
-rw-r--r--README.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..563582a --- /dev/null +++ b/README.md
@@ -0,0 +1,49 @@
1# licenser: plop a license in there
2
3Are you tired of copying and pasting licenses into your new projects?
4Do you always forget what the dang github api thing is?
5Or I don't know, have some other reason why doing licenses is hard?
6
7Well now you don't have to worry!
8Just run `licenser` in your new repo and BLAMMO!
9Done.
10
11## Usage
12
13literally taken from `licenser -h`
14
15```
16licenser [-h|-l] [-y YEAR] [-a AUTHOR] [-o FILE] LICENSE
17
18 -h show this help and exit
19 -l list available licenses and exit
20 -f overwrite existing license
21 -y YEAR set the copyright date to YEAR
22 -a AUTHOR set the copyright holder to AUTHOR
23 -o FILE output to FILE
24 LICENSE which license to use
25
26 YEAR defaults to the current year.
27 AUTHOR is guessed by the following, in order:
28 - git config --get user.name
29 - getent passwd $USER
30 - $USER
31 FILE defaults to LICENSE in the current directory
32```
33
34## Contributing
35
36Send me a request for another license or a pull-thingy
37through [the mailing list](~acdw/licenser@lists.sr.ht).
38
39Or, look at the [roadmap](https://todo.sr.ht/~acdw/licenser).
40
41## License
42
43MIT, baby.
44
45
46## Author
47
48Case Duckworth <acdw@acdw.net> wrote this.
49He did not look around for existing solutions.