diff --git a/README.rst b/README.rst index 73dcf8d..fb15f3d 100644 --- a/README.rst +++ b/README.rst @@ -5,4 +5,47 @@ licor (spelled liquor) is a little script that allows programmers to add copyright/license/warranty disclaimers to all their files easily. +.. contents:: + +Usage +===== + +Usage:: + + licor list-db [] [options] + licor list-all [] [options] + licor list-path [] [options] + licor list-templates [options] + licor print-templ [options] + licor insert-header [] [options] + +Options:: + + --comment-start= Comment start token to use [default: //] + --comment-stop= Comment stop token to use [default: */] + --border= Border character for some fancy stuff [default: *] + -f --fancy Use more fancy comments + --after-comment= A string to seperate border and content (defaults to one blank) + -c --confirm Wait for user confirmation before modifying files + --format= Use a special comment format [default: block] + --license= Use this license template [default: GPLv3] + --single-file Use single-file templates + --copyright Use templates containing copyright information + -a --author= Set the author (required for --copyright) + -p --project= Set the project (required unless --single-file is specified) + -e --file-ending= Search for files ending with this ending [default: c] + -i --ignore-db Ignore the database of processed files + --ignore-paths= Ignore all paths with one of `` in it (comma-seperated) [default: .git] + --pad-to= Pad comment blocks to this width [default: 0] + + +License +======= + +licor is licensed under the GNU AGPLv3. + +Contributing +============ + +Just send a pull request. Or an email.