Added install script & documentation for installing this repository.

README.md

@@ -83,6 +83,48 @@ The following packages are suggested:
 [phpDox]: http://phpdox.de
 [Sami]: https://github.com/FriendsOfPHP/sami
 
+## Usage
+
+This is a simple metapackage, but still can be used in different ways.
+
+#### Global install
+
+This is by far the easiest and most convenient method. Simply having all the tools available system wide.
+
+The following script will install a system wide Composer for you, including the QA tools.
+
+```bash
+bash <(curl -S https://raw.githubusercontent.com/DealerDirect/php-qa-tools/master/bin/install.sh)
+```
+
+If you already have a global Composer setup, you can execute this to include the tools.
+
+```bash
+composer global require "dealerdirect/qa-tools"
+```
+
+#### Project install
+
+The other option is to install this on a per project basis.
+
+```bash
+composer require --dev "dealerdirect/qa-tools"
+```
+
+Or modify your `composer.json` to include `dealerdirect/qa-tools` in the `require-dev` sections.
+
+```json
+{
+  "name": "acme/my-project",
+  "require": {
+    "** your requirements **": "*"
+  },
+  "require-dev": {
+    "dealerdirect/qa-tools": "*"
+  }
+}
+```
+
 ## Contributing
 
 This is an active open-source project. We are always open to people who want to use the code or contribute to it.

bin/install.sh

@@ -0,0 +1,74 @@
+#!/usr/bin/env bash
+set -eu
+
+# Ensure PHP is installed
+if ! command -v php > /dev/null 2>&1; then
+  echo "PHP is not found, installation aborted!"
+  exit 1
+fi
+
+# Ensure Composer is installed/updated
+if ! command -v composer > /dev/null 2>&1; then
+  echo "*** Installing Composer ***"
+  php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
+
+  if [ \
+      "$(curl -S https://composer.github.io/installer.sig)" = \
+      "$(php -r \"echo hash_file\('SHA384', 'composer-setup.php'\);\")" \
+  ]; then
+      php composer-setup.php --quiet --filename=composer
+      sudo mv composer /usr/local/bin/composer
+      rm composer-setup.php
+  else
+      >&2 echo 'ERROR: Invalid composer installer signature'
+      rm composer-setup.php
+      exit 1
+  fi
+fi
+
+echo "*** Updating shell profiles ***"
+# Add Composer's Global Bin to ~/.profile path
+if [[ ! -f "$HOME/.profile" ]]; then
+  touch "$HOME/.profile"
+fi
+if grep -q -F "export COMPOSER_HOME=$HOME/.composer" "$HOME/.profile"; then
+  echo "export COMPOSER_HOME=$HOME/.composer" >> "$HOME/.profile"
+fi
+if grep -q -F "export PATH=$PATH:\$COMPOSER_HOME/vendor/bin" "$HOME/.profile"; then
+  echo "export PATH=$PATH:\$COMPOSER_HOME/vendor/bin" >> "$HOME/.profile"
+fi
+
+# Source the .profile to pick up changes
+# shellcheck source=/dev/null
+source "$HOME/.profile"
+
+# Test if ZSH is installed
+if command -v zsh > /dev/null 2>&1; then
+  # Add Composer's Global Bin to ~/.zprofile path
+  if [[ ! -f "$HOME/.zprofile" ]]; then
+    touch "$HOME/.zprofile"
+  fi
+  if grep -q -F "export COMPOSER_HOME=$HOME/.composer" "$HOME/.zprofile"; then
+    echo "export COMPOSER_HOME=$HOME/.composer" >> "$HOME/.zprofile"
+  fi
+  if grep -q -F "export PATH=$PATH:$COMPOSER_HOME/vendor/bin" "$HOME/.zprofile"; then
+    echo "export PATH=$PATH:$COMPOSER_HOME/vendor/bin" >> "$HOME/.zprofile"
+  fi
+
+  # Source the .zprofile to pick up changes
+  # shellcheck source=/dev/null
+  source "$HOME/.zprofile"
+fi
+
+# Install/Update Dealerdirect QA tools
+if ! grep -q -F "dealerdirect/qa-tools" "$HOME/.composer/composer.json"  > /dev/null 2>&1; then
+  echo "*** Installing Composer Prestissimo in order to speed up next steps ***"
+  composer global require "hirak/prestissimo:^0.3"
+  echo "*** Installing Dealerdirect PHP QA Tools ***"
+  composer global require "dealerdirect/qa-tools:@dev"
+  echo "*** Removing local Prestissimo dependency ***"
+  composer global remove "hirak/prestissimo"
+else
+  echo "*** Updating Dealerdirect PHP QA Tools ***"
+  composer global update "dealerdirect/qa-tools:@dev"
+fi