X-Git-Url: https://iankelling.org/git/?a=blobdiff_plain;f=README;h=c2ec389e8c6d2ee1d9dcc0245297c22e08e23feb;hb=7198fb9b1d94039b1f3dc49405edcd6a0ed8ab1b;hp=8bbec69b987e37ab2163d092e5b0eba9e8e95d9f;hpb=2a2168577b2f877c22724bcc9d02f359813ba72d;p=small-misc-bash diff --git a/README b/README index 8bbec69..c2ec389 100644 --- a/README +++ b/README @@ -1,17 +1,15 @@ -The main usage documentation is near the top of any bash script files which sit -next to this file. +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. -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. +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. -Patches and bugs are very welcome via gitlab. +Please email me if you have a patches (patch file or git repo are fine), +bugs, feedback, or republish this somewhere else: Ian Kelling +. -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. - -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. +There are no known bugs. Any bugs will be added to the individual +documentation of each file. \ No newline at end of file