X-Git-Url: https://iankelling.org/git/?p=lnf;a=blobdiff_plain;f=README;h=a960550c97db9dacb19c2a9ad9d82387010871fd;hp=3e79fecfcf6e3ba1b81913916dd732cb7053c470;hb=97c9c14a824ddb35144a7f96a63eb2999339045e;hpb=58d997c51c2cc8aed9e5028e24e770ba7cfb4321 diff --git a/README b/README index 3e79fec..a960550 100644 --- a/README +++ b/README @@ -1,14 +1,15 @@ -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 documentation is availiable via --help and 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. If a mailing list / forum is ever called for, I will start one. -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.