X-Git-Url: https://iankelling.org/git/?a=blobdiff_plain;f=README;h=c2ec389e8c6d2ee1d9dcc0245297c22e08e23feb;hb=caf671b5c469158479f81f2469e4568e0b938ed9;hp=3e79fecfcf6e3ba1b81913916dd732cb7053c470;hpb=1f1de8997f9eb7a24a7d9cba561ae29b7693b1f6;p=small-misc-bash diff --git a/README b/README index 3e79fec..c2ec389 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 the +script files next to this file. Each file is completely self contained, +and generally unrelated except they are small so it's convenient to put +them in the same repo. -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 with -function are meant to be sourced and used as a function. The +other script file can be stripped of the last line and used as a +function instead of a script. -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. +Please email me if you have a patches (patch file or git repo are fine), +bugs, feedback, or republish this somewhere else: Ian Kelling +. -Patches, bugs, opinions are welcome via gitlab or email Ian Kelling +There are no known bugs. Any bugs will be added to the individual +documentation of each file. \ No newline at end of file