Skip to content

Commit

Permalink
improved documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
makesourcenotcode committed Jan 6, 2024
1 parent d765757 commit c3bc054
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions README.txt → README.name-safe-in-bash-help-information
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
=== SUMMARY ===

version: 1.1.1

Help choosing Bash alias and function names that WON'T come back to bite you
later!

=== VERSION ===

1.1.0

=== MOTIVATION ===

I use Emacs as one of my text editors. Often I prefer it to launch in the
Expand Down Expand Up @@ -43,16 +41,16 @@ name-safe-in-bash <proposed_name>

=== LICENSE ===

This is a Freedom Respecting Technology: think Open Source but not just for well
off people with reliable Internet access and an inexplicable desire to be
terminally online. Learn more at:
This is a Freedom Respecting Technology, think Open Source for everyone, not
just well off people with reliable Internet access. Learn more at:
https://makesourcenotcode.github.io/freedom_respecting_technology.html

It's (admittedly tiny) Open Knowledge Set is as follows:
* the main program source/executable file name_safe_in_bash
* the main program source file / executable file name-safe-in-bash
licensed under GNU GPL v3 ( https://www.gnu.org/licenses/gpl-3.0.txt )
* the documentation / Help Information Set consisting of this file
licensed under GNU FDL v1.3 ( https://www.gnu.org/licenses/fdl-1.3.txt )
* the source / built form of the documentation / Help Information Set consisting
of this README.name-safe-in-bash-help-information file licensed under
GNU FDL v1.3 ( https://www.gnu.org/licenses/fdl-1.3.txt )

=== POSSIBLE FUTURE IMPROVEMENTS ===

Expand All @@ -73,6 +71,7 @@ may be spun up as another project.

=== CHANGELOG ===

v1.1.1: improved documentation
v1.1.0: package manager integration bug fix
v1.0.2: minor doc grammar fix
v1.0.1: minor documentation fix
Expand Down

0 comments on commit c3bc054

Please sign in to comment.