From: Ian Kelling Date: Thu, 12 Jun 2014 22:20:36 +0000 (-0700) Subject: Minor readme update X-Git-Url: https://iankelling.org/git/?a=commitdiff_plain;h=77e35cb8e1e734f1ee846fc1fb70236020354b61;p=lnf Minor readme update --- diff --git a/README b/README index 3e79fec..8bbec69 100644 --- a/README +++ b/README @@ -1,14 +1,17 @@ -This program's main documentation is not here. It is in near the top of any of -the bash script file(s) which sit next to this file. If there is an executable -script in this repo, the documentation is also available by passing --help to -the script/function. +The main usage documentation is near the top of any bash script files which sit +next to this file. -This program is also part of a collection of programs, -https://gitlab.com/iankelling/bash-programs-by-ian, which are unrelated except -a few small things like this file. +Files ending in -function are for sourcing then calling as a function. Files +without -function are exactly the same except they are for calling as a script. + +Patches and bugs are very welcome via gitlab. -For programs with 2 files named like foo and foo-function, they are the same but -provide the flexibility of calling foo the script, or sourcing foo-function and -calling foo the function. +Questions, feedback, etc are very welcome via email to Ian Kelling +. I will add any useful questions, answers, etc. to this +file. The scope/userbase of this project doesn't justify a mailing list, but if +it ever did I would start a discourse instance category to act as a mailing list +and forum. -Patches, bugs, opinions are welcome via gitlab or email Ian Kelling +This program is also part of a collection of programs, +https://gitlab.com/iankelling/bash-programs-by-ian, which are unrelated except +having the same author and being being bash programs.