# ********************************************************************* #
# CrYears                                                               #
# -------                                                               #
# Author : Mahlon R. Smith - The Software Samurai                       #
# Copyright (c) 2026 - 2027 Mahlon R. Smith, The Software Samurai       #
# On the web: https://www.SoftwareSam.us/                               #
#                    - - - - - - - - - -                                #
# Developed under: Perl v:5.40.3                                        #
#                  grep v:3.12                                          #
# ********************************************************************* #
# Copyright Notice:                                                     #
# -----------------                                                     #
# This program is free software: you can redistribute it and/or         #
# modify it under the terms of the GNU General Public License           #
# as published by the Free Software Foundation, either                  #
# version 3 of the License, or (at your option) any later version.      #
#                                                                       #
# This program is distributed in the hope that it will be useful,       #
# but WITHOUT ANY WARRANTY; without even the implied warranty of        #
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  #
# See the GNU General Public License for more details.                  #
#                <http://www.gnu.org/licenses/>.                        #
# ********************************************************************* #
# Introduction:                                                         #
# -------------                                                         #
# This is a stub of the the README file in the parent directory.        #
# - - - - -                                                             #
#                                                                       #
# --------------------------------------------------------------------- #
#                       Unpack the Archive                              #
#                       ==================                              #
#                                                                       #
# 1) Navigate to the base directory where package will be installed.    #
#    example: cd ~/Software                                             #
# 2) Move the archive file to the base directory:                       #
#       mv ~/Dowloads/cryears-0.0.02.tar.bz2 &nbsp; ./.                 #
# 3) Unpack the tar archive:                                            #
#       tar -xjvf cryears-0.0.02.tar.bz2                                #
# 4) Navigate to the target directory:                                  #
#       cd CrYears                                                      #
# 5) Check the version of the Perl compiler currently installed         #
#    on the system:                                                     #
#       perl --version                                                  #
#    If the installed version is earlier that v:5.36, then an           #
#    upgrade is strongly recommended.                                   #
# 6) To begin using cryr.pl, type:                                      #
#       ./cryr.pl --help                                                #
#                       - - - - - - - - - -                             #
# Package Contents:                                                     #
# -----------------                                                     #
# cryr.pl            - Perl script demonstrating grep scans             #
# README             - Release notes (this file)                        #
# 1_TestData/        - Sample source code modules                       #
#   ...                                                                 #
#                                                                       #
# ********************************************************************* #
# Invocation:  Usage: cryr.pl [OPTIONS]                                 #
# -----------                                                           #
# Invocation options fall into two categories:                          #
#  1) Selection of the files to be scanned.                             #
#  2) Setting the parameters for the scan.                              #
#                                                                       #
# File-specification options:                                           #
# ...........................                                           #
#                                                                       #
# Other Options:                                                        #
# ..............                                                        #
#  *  '-version' option:                                                #
#     Report application name, version, and copyright information.      #
#  *  '-help' option:                                                   #
#     Display command-line help.                                        #
#                                                                       #
#  Notes:                                                               #
#  ......                                                               #
#                                                                       #
# ********************************************************************* #
#                                                                       #
# --------------------------------------------------------------------- #
# Version History :                                                     #
# -----------------                                                     #
# See the source file.                                                  #
#                                                                       #
# ********************************************************************* #
