add note about license
[small-misc-bash] / README
diff --git a/README b/README
index c2ec389e8c6d2ee1d9dcc0245297c22e08e23feb..357ea46fbd82cd3b3cde480cc7c78c7efd7d34ac 100644 (file)
--- a/README
+++ b/README
@@ -1,3 +1,37 @@
+# I, Ian Kelling, follow the GNU license recommendations at
+# https://www.gnu.org/licenses/license-recommendations.en.html. They
+# recommend that small programs, < 300 lines, be licensed under the
+# Apache License 2.0. This file contains or is part of one or more small
+# programs. If a small program grows beyond 300 lines, I plan to switch
+# its license to GPL.
+
+# Copyright 2024 Ian Kelling
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+Utility bash programs
+
+dircp              Copy a directory structure
+directory-browser  better cd with forward, backward, and history
+ex                 Extract many types of files
+gitget             Idempotent git clone/pull
+hostmac            Get a host's mac address
+isdiff             Test if FILE1 and FILE2 have the same contents
+ll-function        ls -lA with enhanced output
+psg-function       ps grep. Grep output of ps.
+rmln               wrap rm, recursively expanding symlink arguments
+wpm-game           Typing speed game
+
 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
@@ -12,4 +46,4 @@ bugs, feedback, or republish this somewhere else: Ian Kelling
 <ian@iankelling.org>.
 
 There are no known bugs. Any bugs will be added to the individual
-documentation of each file.
\ No newline at end of file
+documentation of each file.