Add README

1 files changed, 49 insertions, 0 deletions

@@ -0,0 +1,49 @@
+# 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 [-h|-l] [-y YEAR] [-a AUTHOR] [-o FILE] LICENSE
+
+        -h              show this help and exit
+        -l              list available licenses and exit
+        -f              overwrite existing license
+        -y YEAR         set the copyright date to YEAR
+        -a AUTHOR       set the copyright holder to AUTHOR
+        -o FILE         output to FILE
+        LICENSE         which license to use
+
+        YEAR defaults to the current year.
+        AUTHOR is guessed by the following, in order:
+                - git config --get user.name
+                - getent passwd $USER
+                - $USER
+        FILE defaults to LICENSE in the current directory
+```
+
+## 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.