Bashsmith

Provides a template for the setup and construction of new Bash scripts.

Table of Contents

• Features
• Requirements
• Setup
• Usage
• Tests
• Versioning
• Code of Conduct
• Contributions
• License
• History
• Credits

Features

• Provides default project structure for creating new Bash projects.
• Provides default settings for making Bash scripts easier to develop and debug.

Requirements

• Bash

Setup

Open a terminal window and execute one of the following setup sequences depending on your version preference:

Current Version (stable):

git clone git://github.com/bkuhlmann/bashsmith.git
cd bashsmith
git checkout v1.1.0

Master Version (unstable):

git clone git://github.com/bkuhlmann/bashsmith.git
cd bashsmith

Usage

Clone this repo and rename as needed. All files located within this project provide the basic structure/blueprint for creating new Bash script projects. The structure is organized as follows:

/lib = A folder for all Bash functions and custom code.
  /cli.sh = Provides prompt options for the main run.sh script.
/settings = The global/project settings for easy manipulation/tweaking.
  /main.sh = The global settings (set with safe defaults).
/CHANGELOG.md = The details of past version releases.
/CODE_OF_CONDUCT.md = Guidelines for encouraging harassment-free contributions.
/CONTRIBUTING.md = The details of how to contribute to the project.
/LICENSE.md = The license and copyright legalities of the project.
/README.md = The project overview, setup, usage, test, getting started, etc. details.
/run.sh = The main run script (which loads the lib and settings).

Tests

Consider using Bats.

Versioning

Read Semantic Versioning for details. Briefly, it means:

• Patch (x.y.Z) - Incremented for small, backwards compatible bug fixes.
• Minor (x.Y.z) - Incremented for new, backwards compatible public API enhancements and/or bug fixes.
• Major (X.y.z) - Incremented for any backwards incompatible public API changes.

Code of Conduct

Please note that this project is released with a CODE OF CONDUCT. By participating in this project you agree to abide by its terms.

Contributions

Read CONTRIBUTING for details.

License

Copyright (c) 2014 Alchemists. Read the LICENSE for details.

History

Read the CHANGELOG for details.

Credits

Developed by Brooke Kuhlmann at Alchemists.