[99] DESCRIPTION -------------------------------------------------------------

Bash helper scripts.

[100] VERSION ----------------------------------------------------------------

0.0.5.9

[101] AUTHORS ----------------------------------------------------------------

Kostya Zolotarov <kostya.zolotarov@gmail.com>

[102] FEATURES ---------------------------------------------------------------

* wizard - Generate new project
* setup - Setup new source module 
* build - Build the source module 
* readme - Build/update the source module README file 
* files - Build/update the source module FILES file 
* tasks - Build/update the source module TASKS file 
* authors - Build/update list of the source module contributors
* changelog - Build/update the source module CHANGELOG file 
* version - Increment the source module version inside VERSION file 
* install - Install the source module 
* uninstall - Uninstall the source module 

[103] EXAMPLES ---------------------------------------------------------------

Project
-------

Generate new project template.

    $ project setup
    .
    |--  ./API
    |--  ./AUTHORS
    |--  ./BACKGROUND
    |--  ./BUILD
    |--  ./CHANGELOG
    |--  ./DEFECTS
    |--  ./DEPENDENCIES
    |--  ./DESCRIPTION
    |--  ./DESIGN
    |--  ./EXAMPLES
    |--  ./FEATURES
    |--  ./FILES
    |--  ./INSTALL
    |--  ./LICENSE
    |--  ./REQUIREMENTS
    |--  ./SOURCES
    |--  ./TEST
    \--  ./VERSION
    
    18 files

Generate a list of project authors and store this list in  the AUTHORS file. 

    $ project authors

Generate the project list of commits and store them in the CHANGELOG file.

    $ project changelog

Generate a list of project files and store them in the FILES file.

    $ project files

Increment the project version and store it in the VERSION file.

    $ project version

Collect information form AUTHORS, CHANGELOG, FILES, VERSION, etc and store everything in the updated README file.

    $ project readme

Build AUTHORS, CHANGELOG, FILES, VERSION, and README with a single key stroke.

    $ project build

Wizard
------

Generate Bash CLI executable proejct.

    $ project wizard bash cli helloworld
    $ ls -lt helloworld

    total 32
    drwxr-xr-x 2 kz9676 kz9676 4096 Nov 12 16:58 log
    drwxr-xr-x 2 kz9676 kz9676 4096 Nov 12 16:58 doc
    drwxr-xr-x 2 kz9676 kz9676 4096 Nov 12 16:58 etc
    drwxr-xr-x 2 kz9676 kz9676 4096 Nov 12 16:58 lib
    drwxr-xr-x 2 kz9676 kz9676 4096 Nov 12 16:58 bin
    drwxr-xr-x 2 kz9676 kz9676 4096 Nov 12 16:58 src
    drwxr-xr-x 2 kz9676 kz9676 4096 Nov 12 16:58 include
    -rw-r--r-- 1 kz9676 kz9676 2229 Nov 12 16:58 tags
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:57 LICENSE
    lrwxrwxrwx 1 kz9676 kz9676   55 Nov 12 16:57 Makefile -> /home/kz9676/Sources/makefiles/src/Makefile.debian.bash
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:57 FILES
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:57 DEFECTS
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:57 INSTALL
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:57 BUILD
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:57 TEST
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:57 DEPENDENCIES
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:57 SOURCES
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:57 EXAMPLES
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:57 API
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:57 DESIGN
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:57 REQUIREMENTS
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:57 BACKGROUND
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:57 FEATURES
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:57 AUTHORS
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:57 VERSION
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:57 DESCRIPTION

Generate C CLI executable proejct.

    $ project wizard c cli helloworld
    $ ls -lt helloworld

    total 40
    drwxr-xr-x 2 kz9676 kz9676 4096 Nov 12 16:14 log
    drwxr-xr-x 2 kz9676 kz9676 4096 Nov 12 16:14 doc
    drwxr-xr-x 2 kz9676 kz9676 4096 Nov 12 16:14 etc
    drwxr-xr-x 2 kz9676 kz9676 4096 Nov 12 16:14 lib
    drwxr-xr-x 2 kz9676 kz9676 4096 Nov 12 16:14 bin
    drwxr-xr-x 2 kz9676 kz9676 4096 Nov 12 16:14 obj
    drwxr-xr-x 2 kz9676 kz9676 4096 Nov 12 16:14 asm
    drwxr-xr-x 2 kz9676 kz9676 4096 Nov 12 16:14 pro
    drwxr-xr-x 2 kz9676 kz9676 4096 Nov 12 16:14 src
    drwxr-xr-x 2 kz9676 kz9676 4096 Nov 12 16:14 include
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:14 LICENSE
    lrwxrwxrwx 1 kz9676 kz9676   54 Nov 12 16:14 Makefile -> /home/kz9676/Sources/makefiles/src/Makefile.debian.gcc
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:14 DEFECTS
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:14 FILES
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:14 INSTALL
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:14 BUILD
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:14 TEST
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:14 SOURCES
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:14 DEPENDENCIES
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:14 EXAMPLES
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:14 API
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:14 DESIGN
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:14 REQUIREMENTS
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:14 BACKGROUND
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:14 FEATURES
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:14 AUTHORS
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:14 DESCRIPTION
    -rw-r--r-- 1 kz9676 kz9676    0 Nov 12 16:14 VERSION

Log
---

    $ log success "Operation completed successfully"
    $ log warning "Running out of disk space"
    $ log error "File not found"

[104] DEPENDENCIES -----------------------------------------------------------

GNU bash, version 5.0.3

[105] SOURCES ----------------------------------------------------------------

    * origin/development  - is the main branch where the source code of HEAD
                            always reflects a state with the latest delivered
                            development changes for the next release

[106] INSTALL ----------------------------------------------------------------

The following command gets the bash-utils installed into a local host environment:

    $ bash ./project install

The following command removes the bash-utils from your local host environment:

    $ bash ./project uninstall

[107] FILES ------------------------------------------------------------------

.
|--  ./API
|--  ./AUTHORS
|--  ./BACKGROUND
|--  ./BUILD
|--  ./CHANGELOG
|--  ./configuration.directory
|--  ./configuration.file
|--  ./configuration.log
|--  ./configuration.project
|--  ./configuration.project.null
|--  ./configuration.version
|--  ./DEFECTS
|--  ./DEPENDENCIES
|--  ./DESCRIPTION
|--  ./DESIGN
|--  ./directory
|--  ./directory_assert
|--  ./directory_assert_copied
|--  ./directory_assert_created
|--  ./directory_assert_deleted
|--  ./directory_assert_empty
|--  ./directory_assert_found
|--  ./directory_assert_moved
|--  ./directory_assert_read
|--  ./directory_assert_renamed
|--  ./directory_assert_written
|--  ./directory_copy
|--  ./directory_create
|--  ./directory_delete
|--  ./directory_find
|--  ./directory_move
|--  ./directory_rename
|--  ./EXAMPLES
|--  ./FEATURES
|--  ./file
|--  ./file_assert
|--  ./file_assert_copied
|--  ./file_assert_created
|--  ./file_assert_deleted
|--  ./file_assert_empty
|--  ./file_assert_found
|--  ./file_assert_moved
|--  ./file_assert_read
|--  ./file_assert_renamed
|--  ./file_assert_written
|--  ./file_copy
|--  ./file_create
|--  ./file_delete
|--  ./file_find
|--  ./file_move
|--  ./file_read
|--  ./file_rename
|--  ./FILES
|--  ./file_write
|--  ./INSTALL
|--  ./LICENSE
|--  ./log
|--  ./log_error
|--  ./log_information
|--  ./log_success
|--  ./log_warning
|--  ./project
|--  ./project_authors.template
|--  ./project_build.template
|--  ./project_changelog.template
|--  ./project_files.template
|--  ./project_install
|--  ./project_package.template
|--  ./project_readme.template
|--  ./project_setup.template
|--  ./project_tasks.template
|--  ./project_uninstall.template
|--  ./project_version.template
|--  ./project_wizard.template
|--  ./README
|--  ./REQUIREMENTS
|--  ./SOURCES
|--  ./tags
|--  ./TASKS
|--  ./template.bash.configuration
|--  ./template.bash.executable
|--  ./template.bash.function
|--  ./template.bash.test
|--  ./template.bash.variable
|--  ./template.gitignore
|--  ./TEST
|--  ./test.file_assert
|--  ./test.file_copy
|--  ./test.file_create
|--  ./test.file_delete
|--  ./test.file_find
|--  ./test.file_move
|--  ./test.file_read
|--  ./test.file_rename
|--  ./test.file_write
|--  ./VERSION
|--  ./version
\--  ./version_increment

98 files

[108] LICENSE ----------------------------------------------------------------

The MIT License (MIT)

Copyright (c) 2015-2020 Kostya Zolotarov

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.