Nathaniel Landau 74a447c331 Text update
2015-05-26 13:44:30 -04:00
2015-05-24 21:28:29 -04:00
2015-01-07 22:59:39 -05:00
2015-05-24 21:28:29 -04:00
2015-05-07 10:21:02 -04:00
2015-03-23 09:31:50 -04:00
2015-01-08 17:49:51 -05:00
2015-05-26 13:44:30 -04:00

My Shell Scripts

This is the centralized repository of all the shell scripts which I use for a number of different purposes.

Important: I am a novice programmer and I bear no responsibility whatsoever if any of these scripts that I have written wipes your computer, destroys your data, crashes your car, or otherwise causes mayhem and destruction. USE AT YOUR OWN RISK.

What's here

  • etc/ - Many of my scripts and shared functions call for configuration files. These configs are saved here.
  • lib/ - Shared functions and libraries that are used throughout the scripts.
  • setupScripts/ - Scripts that configure new Mac computers from scratch. These scripts perform such tasks as:
    • Insalling Homebrew & associated packages
    • Installing mac applications using Homebrew Cask
    • Configuring OSX to my liking
    • Syncing user preferences and files using Mackup
    • Installing RVM and associated Gems
    • Pushing a new SSH key to Github
  • syncScripts/ - Scripts which use RSYNC and Unison to keep different directories and computers in sync.

Usage

Each of the directories has its own README describing in more depth how to use the files contained within. Most of the scripts here won't work without the scripting utilities in lib/.

Versioning

This project implements the Semantic Versioning guidelines.

Releases will be numbered with the following format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

  • Breaking backward compatibility bumps the major (and resets the minor and patch)
  • New additions without breaking backward compatibility bumps the minor (and resets the patch)
  • Bug fixes and misc changes bumps the patch

For more information on SemVer, please visit SemVer.

A Note on Code Reuse

The scripts herein were created by me over many years without ever having the intention to make them public. As a novice programmer, I have Googled, GitHubbed, and StackExchanged a path to solve my own scripting needs. Quite often I would lift a function whole-cloth from a GitHub repo and not keep track of it's original location. I have done my best within the scripts to recreate my footsteps and give credit to the original creators of the code when possible. Unfortunately, I fear that I missed as many as I found. My goal of making these scripts public is not to take credit for the wonderful code written by others.

Description
Shell scripting utility functions and a bash script boilerplate template
Readme MIT 3.3 MiB
Languages
Shell 88.3%
sed 11.7%