Added version release changes.

- Simplifies the name since "Log" is implied and is one of the three
  common file names for this type of information: CHANGELOG.md,
  CHANGES.md, and HISTORY.md

[ci skip]

CHANGELOG.md

@@ -1,3 +0,0 @@
-# v1.0.0 (2016-10-05)
-
-- Initial version.

CHANGES.md

@@ -0,0 +1,21 @@
+# v1.3.0 (2017-01-01)
+
+- Updated README versioning documentation.
+- Removed CHANGELOG.md (use CHANGES.md instead).
+
+# v1.2.0 (2016-10-12)
+
+- Fixed reinstaller path issues with application and extension scripts.
+- Added screencast to README.
+
+# v1.1.0 (2016-10-11)
+
+- Fixed Bash script header to dynamically load correct environment.
+- Fixed verification of Homebrew application installs.
+- Added script hook for App Store software install.
+- Added script hooks for unfinished custom configurations.
+- Updated and clarified README documentation.
+
+# v1.0.0 (2016-10-05)
+
+- Initial version.

README.md

@@ -2,15 +2,27 @@
 
 [![Patreon](https://img.shields.io/badge/patreon-donate-brightgreen.svg)](https://www.patreon.com/bkuhlmann)
 
-Shell scripts for automated macOS machine setup. This project provides the foundational tooling for
+Shell scripts for automated macOS machine setup.
-automated macOS machine setup. To customize further see the companion
+
-[macOS Config](https://github.com/bkuhlmann/mac_os-config) project for details.
+This project is a framework for automating the setup of a macOS machine. In order to illustrate the
+potential of what this project can do, please see the companion
+[macOS Config](https://github.com/bkuhlmann/mac_os-config) project for details. The *macOS Config*
+project is an opinionated configuration which meets the needs of my development environment but is
+also meant to serve as an example and guide for building your own personalized setup. Here is how
+the two projects are meant to be used:
+
+- **macOS** (this project) - Foundation and framework for building customizated macOS machine
+  setups.
+- **[macOS Config](https://github.com/bkuhlmann/mac_os-config)** - The layer on top of this *macOS*
+  project which defines a custom machine setup and base implementation. The project is meant to be
+  forked for as many custom machine setups as needed.
 
 <!-- Tocer[start]: Auto-generated, don't remove. -->
 
 # Table of Contents
 
 - [Features](#features)
+- [Screencast](#screencast)
 - [Requirements](#requirements)
 - [Setup](#setup)
 - [Usage](#usage)
@@ -26,18 +38,29 @@ automated macOS machine setup. To customize further see the companion
 
 # Features
 
-- Provides a command line interface for installation and management of macOS software.
+- Provides a command line interface, written in Bash with no additional dependencies, for
-- Downloads and installs development tooling (required by Homebrew):
+  installation and management of a macOS machine.
+- Supports macOS boot disk creation for setting up a machine with a fresh install of the operation
+  system.
+- Downloads and installs development tools (required by Homebrew):
     - [Xcode Command Line Tools](https://developer.apple.com/xcode)
     - [Java SE Development Kit](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
 - Downloads, installs, and configures [Homebrew](http://brew.sh) command line software.
-- Downloads, installs, and configures software applications generally not in the
+- Downloads, installs, and configures
-  [App Store](http://www.apple.com/macosx/whats-new/app-store.html).
+  [App Store](http://www.apple.com/macosx/whats-new/app-store.html) software.
-- Downloads, installs, and configures software extensions.
+- Downloads, installs, and configures non-App Store software applications.
+- Downloads, installs, and configures software application extensions.
+- Applies basic and default software settings.
+- Sets up and configures installed software for use.
+- Supports restoration of machine backups.
+
+# Screencast
+
+[![asciicast](https://asciinema.org/a/88971.png)](https://asciinema.org/a/88971)
 
 # Requirements
 
-0. [macOS](https://www.apple.com/macos) (with latest software updates applied)
+0. [macOS Sierra](https://www.apple.com/macos) (with latest software updates applied)
 0. [Xcode](https://developer.apple.com/xcode) (with accepted license agreement)
 
 # Setup
@@ -49,7 +72,7 @@ Current Version (stable):
 
     git clone https://github.com/bkuhlmann/mac_os.git
     cd mac_os
-    git checkout v1.0.0
+    git checkout v1.3.0
 
 Master Version (unstable):
 
@@ -67,12 +90,13 @@ You will be presented with the following options:
     Boot:
       B:  Create boot disk.
     Install:
-      b:  Apply basic system settings.
+      b:  Apply basic settings.
       t:  Install development tools.
       h:  Install Homebrew software.
+      m:  Install Mac App Store software.
       a:  Install application software.
       x:  Install application software extensions.
-      d:  Apply software defaults.
+      d:  Apply default settings.
       s:  Setup installed software.
       i:  Install everything (i.e. executes all install options).
     Restore:
@@ -91,8 +115,8 @@ Choose option `i` to run all install options or select a specific option to run
 Each option is designed to be re-run if necessary. This can also be handy for performing upgrades,
 re-running a missing/failed install, etc.
 
-The option prompt can be skipped by passing the desired option directly to the run.sh script. For
+The option prompt can be skipped by passing the desired option directly to the `bin/run` script. For
-example, executing `./run.sh i` will execute the complete software install process.
+example, executing `bin/run i` will execute the complete software install process.
 
 The machine should be rebooted after all install tasks have completed to ensure all settings have
 been loaded.
@@ -102,27 +126,40 @@ in order to manage installed software and benefit from future upgrades.
 
 ## Customization
 
-Global settings can be configured via the following script:
+All executable scripts can be found in the `bin` folder:
 
-- `lib/settings.sh`
+- `bin/apply_basic_settings`: Applies basic, initial, settings for setting up a machine. *This is
+  meant to be customized.*
+- `bin/apply_default_settings`: Applies useful system and application defaults. *This is meant to be
+  customized.*
+- `bin/create_boot_disk`: Creates macOS boot disk.
+- `bin/install_app_store`: Installs macOS, GUI-based, App Store applications. *This is meant to be
+  customized.*
+- `bin/install_applications`: Installs macOS, GUI-based, non-App Store applications. *This is meant
+  to be customized.*
+- `bin/install_dev_tools`: Installs macOS development tools required by Homebrew.
+- `bin/install_extensions`: Installs macOS application extensions and add-ons. *This is meant to be
+  customized.*
+- `bin/install_homebrew`: Installs Homebrew managed software. *This is meant to be customized.*
+- `bin/restore_backup`: Restores system/application settings from backup image. *This is meant to be
+  customized.*
+- `bin/run`: The main script and interface for macOS setup.
+- `bin/setup_software`: Configures and launches (if necessary) installed software. *This is meant to
+  be customized.*
 
-All script programs can be found in the `bin` folder:
+The `lib` folder provides the base framework for installing, re-installing, and uninstalling
-
-- `bin/create_boot_disk` = Creates macOS boot disk.
-- `bin/install_dev_tools` = Installs macOS development tools required by Homebrew.
-- `bin/run` - The main script and interface for macOS setup.
-
-The `lib` folder provides foundational functions for installing, re-installing, and uninstalling
 software. Everything provided via the [macOS Config](https://github.com/bkuhlmann/mac_os-config)
 project is built upon the functions found in the `lib` folder. See the
 [macOS Config](https://github.com/bkuhlmann/mac_os-config) project for further details.
 
+  - `lib/settings.sh`: Defines global settings for software applications, extensions, etc.
+
 # Versioning
 
 Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
 
-- Patch (x.y.Z) - Incremented for small, backwards compatible bug fixes.
+- 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.
+- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
 - Major (X.y.z) - Incremented for any backwards incompatible public API changes.
 
 # Code of Conduct
@@ -137,11 +174,11 @@ Read [CONTRIBUTING](CONTRIBUTING.md) for details.
 # License
 
 Copyright (c) 2016 [Alchemists](https://www.alchemists.io).
-Read the [LICENSE](LICENSE.md) for details.
+Read [LICENSE](LICENSE.md) for details.
 
 # History
 
-Read the [CHANGELOG](CHANGELOG.md) for details.
+Read [CHANGES](CHANGES.md) for details.
 Built with [Bashsmith](https://github.com/bkuhlmann/bashsmith).
 
 # Credits

bin/apply_basic_settings

@@ -0,0 +1,18 @@
+#! /usr/bin/env bash
+
+# DESCRIPTION
+# Applies basic system settings.
+
+# SETTINGS
+set -o nounset
+set -o errexit
+set -o pipefail
+IFS=$'\n\t'
+SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/apply_basic_settings"
+
+# EXECUTION
+if [[ -x "$SCRIPT_PATH" ]]; then
+  "$SCRIPT_PATH"
+else
+  printf "WARNING: Basic settings script does not exist or is not executable.\n"
+fi

bin/apply_default_settings

@@ -0,0 +1,18 @@
+#! /usr/bin/env bash
+
+# DESCRIPTION
+# Applies default settings.
+
+# SETTINGS
+set -o nounset
+set -o errexit
+set -o pipefail
+IFS=$'\n\t'
+SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/apply_default_settings"
+
+# EXECUTION
+if [[ -x "$SCRIPT_PATH" ]]; then
+  "$SCRIPT_PATH"
+else
+  printf "WARNING: Default settings script does not exist or is not executable.\n"
+fi

bin/create_boot_disk

@@ -1,4 +1,4 @@
-#! /bin/bash
+#! /usr/bin/env bash
 
 # DESCRIPTION
 # Creates macOS boot disk.

bin/install_app_store

@@ -0,0 +1,18 @@
+#! /usr/bin/env bash
+
+# DESCRIPTION
+# Installs App Store software.
+
+# SETTINGS
+set -o nounset
+set -o errexit
+set -o pipefail
+IFS=$'\n\t'
+SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_app_store"
+
+# EXECUTION
+if [[ -x "$SCRIPT_PATH" ]]; then
+  "$SCRIPT_PATH"
+else
+  printf "WARNING: App Store install script does not exist or is not executable.\n"
+fi

bin/install_applications

@@ -0,0 +1,18 @@
+#! /usr/bin/env bash
+
+# DESCRIPTION
+# Installs applications.
+
+# SETTINGS
+set -o nounset
+set -o errexit
+set -o pipefail
+IFS=$'\n\t'
+SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_applications"
+
+# EXECUTION
+if [[ -x "$SCRIPT_PATH" ]]; then
+  "$SCRIPT_PATH"
+else
+  printf "WARNING: Applications install script does not exist or is not executable.\n"
+fi

bin/install_dev_tools

@@ -1,4 +1,4 @@
-#! /bin/bash
+#! /usr/bin/env bash
 
 # DESCRIPTION
 # Installs development tooling requirements.

bin/install_extensions

@@ -0,0 +1,18 @@
+#! /usr/bin/env bash
+
+# DESCRIPTION
+# Installs application extensions.
+
+# SETTINGS
+set -o nounset
+set -o errexit
+set -o pipefail
+IFS=$'\n\t'
+SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_extensions"
+
+# EXECUTION
+if [[ -x "$SCRIPT_PATH" ]]; then
+  "$SCRIPT_PATH"
+else
+  printf "WARNING: Application extensions install script does not exist or is not executable.\n"
+fi

bin/install_homebrew

@@ -0,0 +1,18 @@
+#! /usr/bin/env bash
+
+# DESCRIPTION
+# Installs Homebrew software.
+
+# SETTINGS
+set -o nounset
+set -o errexit
+set -o pipefail
+IFS=$'\n\t'
+SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/install_homebrew"
+
+# EXECUTION
+if [[ -x "$SCRIPT_PATH" ]]; then
+  "$SCRIPT_PATH"
+else
+  printf "WARNING: Homebrew install script does not exist or is not executable.\n"
+fi

bin/restore_backup

@@ -0,0 +1,18 @@
+#! /usr/bin/env bash
+
+# DESCRIPTION
+# Performs restoration of backup data.
+
+# SETTINGS
+set -o nounset
+set -o errexit
+set -o pipefail
+IFS=$'\n\t'
+SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/restore_backup"
+
+# EXECUTION
+if [[ -x "$SCRIPT_PATH" ]]; then
+  "$SCRIPT_PATH"
+else
+  printf "WARNING: Restore backup script does not exist or is not executable.\n"
+fi

bin/run

@@ -1,4 +1,4 @@
-#! /bin/bash
+#! /usr/bin/env bash
 
 # DESCRIPTION
 # Executes the command line interface.
@@ -40,6 +40,7 @@ while true; do
     printf "    b:  Apply basic settings.\n"
     printf "    t:  Install development tools.\n"
     printf "    h:  Install Homebrew software.\n"
+    printf "    m:  Install Mac App Store software.\n"
     printf "    a:  Install application software.\n"
     printf "    x:  Install application software extensions.\n"
     printf "    d:  Apply default settings.\n"

bin/setup_software

@@ -0,0 +1,18 @@
+#! /usr/bin/env bash
+
+# DESCRIPTION
+# Sets up and launches (if necessary) installed software.
+
+# SETTINGS
+set -o nounset
+set -o errexit
+set -o pipefail
+IFS=$'\n\t'
+SCRIPT_PATH="$MAC_OS_CONFIG_PATH/bin/setup_software"
+
+# EXECUTION
+if [[ -x "$SCRIPT_PATH" ]]; then
+  "$SCRIPT_PATH"
+else
+  printf "WARNING: Software setup script does not exist or is not executable.\n"
+fi

lib/installers.sh

@@ -1,4 +1,4 @@
-#! /bin/bash
+#! /usr/bin/env bash
 
 # DESCRIPTION
 # Defines software installer functions.

lib/options.sh

@@ -1,4 +1,4 @@
-#! /bin/bash
+#! /usr/bin/env bash
 
 # DESCRIPTION
 # Defines command line prompt options.
@@ -11,31 +11,34 @@ process_option() {
     'B')
       bin/create_boot_disk;;
     'b')
-      "$MAC_OS_CONFIG_PATH/bin/apply_basic_settings";;
+      bin/apply_basic_settings;;
     't')
       bin/install_dev_tools;;
     'h')
-      "$MAC_OS_CONFIG_PATH/bin/install_homebrew";;
+      bin/install_homebrew;;
+    'm')
+      bin/install_app_store;;
     'a')
-      "$MAC_OS_CONFIG_PATH/bin/install_applications";;
+      bin/install_applications;;
     'x')
-      "$MAC_OS_CONFIG_PATH/bin/install_extensions";;
+      bin/install_extensions;;
     'd')
-      "$MAC_OS_CONFIG_PATH/bin/apply_default_settings";;
+      bin/apply_default_settings;;
     's')
-      "$MAC_OS_CONFIG_PATH/bin/setup_software";;
+      bin/setup_software;;
     'i')
       caffeinate_machine
-      "$MAC_OS_CONFIG_PATH/bin/apply_basic_settings"
+      bin/apply_basic_settings
       bin/install_dev_tools
-      "$MAC_OS_CONFIG_PATH/bin/install_homebrew"
+      bin/install_homebrew
-      "$MAC_OS_CONFIG_PATH/bin/install_applications"
+      bin/install_app_store
-      "$MAC_OS_CONFIG_PATH/bin/install_extensions"
+      bin/install_applications
-      "$MAC_OS_CONFIG_PATH/bin/apply_default_settings"
+      bin/install_extensions
-      "$MAC_OS_CONFIG_PATH/bin/setup_software"
+      bin/apply_default_settings
+      bin/setup_software
       clean_work_path;;
     'R')
-      "$MAC_OS_CONFIG_PATH/bin/restore_backup";;
+      bin/restore_backup;;
     'c')
       verify_homebrews
       verify_applications

lib/reinstallers.sh

@@ -1,4 +1,4 @@
-#! /bin/bash
+#! /usr/bin/env bash
 
 # DESCRIPTION
 # Defines reinstall functions.
@@ -6,13 +6,13 @@
 # Reinstall application.
 reinstall_application() {
   uninstall_application
-  scripts/applications.sh
+  bin/install_applications
 }
 export -f reinstall_application
 
 # Reinstall extension.
 reinstall_extension() {
   uninstall_extension
-  scripts/extensions.sh
+  bin/install_extensions
 }
 export -f reinstall_extension

lib/restorers.sh

@@ -1,4 +1,4 @@
-#! /bin/bash
+#! /usr/bin/env bash
 
 # DESCRIPTION
 # Defines software restore functions.

lib/settings.sh

@@ -1,4 +1,4 @@
-#! /bin/bash
+#! /usr/bin/env bash
 
 # DESCRIPTION
 # Defines global settings.

lib/uninstallers.sh

@@ -1,4 +1,4 @@
-#! /bin/bash
+#! /usr/bin/env bash
 
 # DESCRIPTION
 # Defines uninstall functions.

lib/utilities.sh

@@ -1,4 +1,4 @@
-#! /bin/bash
+#! /usr/bin/env bash
 
 # DESCRIPTION
 # Defines general utility functions.

lib/verifiers.sh

@@ -1,4 +1,4 @@
-#! /bin/bash
+#! /usr/bin/env bash
 
 # DESCRIPTION
 # Defines verification/validation functions.
@@ -39,7 +39,7 @@ verify_homebrews() {
 
       verify_homebrew "$application" "${applications[*]}"
     fi
-  done < "$PWD/scripts/homebrew.sh"
+  done < "$MAC_OS_CONFIG_PATH/bin/install_homebrew"
 
   printf "Homebrew check complete.\n"
 }