Populate repository

- Update all markdown files
- Add first scripts

Author: andresgongora

AUTHORS.md

@@ -0,0 +1,42 @@
+<!--------------------------------------+-------------------------------------->
+##                                    ABOUT
+<!--------------------------------------+-------------------------------------->
+
+This file contains the list of people involved in the development of these
+scripts, which started as just a bunch of loose file that I kept around
+for convenience, and most often than not, just for fun :)
+
+If you feel someone is missing, please fork and pull-request.
+You may add your name, email, a link to your personal web-site/blog/profile
+(no commercial links) and a brief contribution summary.
+
+<!-- The following list is roughly sorted in reverse cronological order. -->
+
+
+
+
+
+
+<!--------------------------------------+-------------------------------------->
+##                          DEVELOPERS & CONTRIBUTORS
+<!--------------------------------------+-------------------------------------->
+
+*	**Andres Gongora**  
+	<[email protected]>  
+	www.andresgongora.com  
+	Main developer
+
+
+
+
+
+
+<!--------------------------------------+-------------------------------------->
+##                                    OTHERS
+<!--------------------------------------+-------------------------------------->
+
+Bug reports and new feature suggestions, provideded by users world-wide,
+are usually mentioned in the changelogs.
+
+We kindly thank all of them for their valuable feedback.
+

LICENSE

@@ -1,7 +1,7 @@
                     GNU GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007
 
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
@@ -645,7 +645,7 @@ the "copyright" line and a pointer to where the full notice is found.
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
@@ -664,11 +664,11 @@ might be different; for a GUI interface, you would use an "about box".
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
 For more information on this, and how to apply and follow the GNU GPL, see
-<https://www.gnu.org/licenses/>.
+<http://www.gnu.org/licenses/>.
 
   The GNU General Public License does not permit incorporating your program
 into proprietary programs.  If your program is a subroutine library, you
 may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
-<https://www.gnu.org/licenses/why-not-lgpl.html>.
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.

README.md

@@ -1,2 +1,103 @@
-# bash-tools
-A collection of bash utility scripts
+<!--------------------------------------+-------------------------------------->
+#                                  Introduction
+<!--------------------------------------+-------------------------------------->
+My personal collection of bash utility scripts, meant to support a wide range of
+applications; but not very useful by themselves.
+You can find more details and similar tools on
+[Yet Another Linux'n Electronics Blog](https://yalneb.blogspot.com/).
+
+
+*DISCLAIMER*
+Note that some script snippets might be from third parties.
+I collected them over many years from forums, wikis, and chats.
+The original authors, if known, are referenced within the individual scripts.
+If you recognize a snippet and the file has no reference
+(specially in the older ones), kindly let me know.
+
+
+
+
+
+
+<!--------------------------------------+-------------------------------------->
+#                                    Overview
+<!--------------------------------------+-------------------------------------->
+
+| Folder                	| Script                         	| Description                                          	|
+|-----------------------	|--------------------------------	|------------------------------------------------------	|
+|                       	|                                	|                                                      	|
+| /                      	| color.sh                           	| Colorize and format command line text                	|
+| /                      	| load_config.sh                      	| Retrieve script configurations from a file        	|
+| /                      	| edit_text_file.sh                    	| Add a fragment of text to file without duplicating it	|
+| /                      	| print_utils.sh                       	| Utility function to print text blocks to termional   	|
+| /                      	| shorten_path.sh                      	| Makes a path name shorter without truncating names    |
+|                       	|                                	|                                                      	|
+|                       	|                                	|                                                      	|
+
+
+
+
+
+
+<!--------------------------------------+-------------------------------------->
+#                                   Contribute
+<!--------------------------------------+-------------------------------------->
+
+This project is only possible thanks to the effort of and passion of many, 
+including mentors, developers, and of course, our beloved coffe vending machine.
+If you like this collection of scripts and want to contribute in any way,
+you are most welcome to do so.
+
+You can find a detailed list of everyone involved in the development of
+these scripts in [AUTHORS.md](AUTHORS.md). Thanks to all of you!
+
+
+
+### Help us improve
+
+* Add your own scripts: do you have some cool scripts you wold like to 
+  add to this collection? Don't hesitate to create a pull-request or,
+  alternatively, contact the authors over email.
+* [Report a bug](https://github.com/andresgongora/bash-tools/issues): 
+  if you notice that something is not right, tell us. 
+  We'll try to fix it ASAP.
+* Become a developer: fork this repo and become an active developer!
+  Take a look at the [issuess](https://github.com/andresgongora/bash-tools/issues)
+  for suggestions of where to start. Also, take a look at our 
+  [coding style](coding_style.md).
+* Push your one-time changes: even if its a tiny change, 
+  feel free to fill in a pull-request!
+
+
+
+### Git branches
+
+There are two branches in this repository:
+
+* **master**: this is the main branch, and thus contains fully functional 
+  scripts. When you want to use the scripts as an _user_, 
+  this is the branch you want to clone or download.
+* **develop**: this branch contains all the new features and most recent 
+  contributions. It is always _stable_, in the sense that you can use it
+  without major inconveniences. 
+  However, its very prone to undetected bugs and it might be subject to major
+  unanounced changes. If you want to contribute, this is the branch 
+  you should pull-request to.
+
+
+
+
+
+
+<!--------------------------------------+-------------------------------------->
+#                                    License
+<!--------------------------------------+-------------------------------------->
+
+Copyright (c) 2014-2019, Andres Gongora - www.andresgongora.com
+
+* This software is released under a GPLv3 license.
+  Read [license-GPLv3.txt](LICENSE),
+  or if not present, <http://www.gnu.org/licenses/>.
+* If you need a closed-source version of this software
+  for commercial purposes, please contact the authors.
+