From 9772ba9de4eec754f27f9dc83f5b3fc744e8ad2d Mon Sep 17 00:00:00 2001 From: Joshua Appelman Date: Sun, 8 Jun 2014 01:42:20 +0200 Subject: [PATCH 1/2] Adds homebrew installation steps to README. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index f448fad..cd369a5 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,14 @@ The goals of ShellCheck are: ShellCheck is written in Haskell, and requires at least 1 GB of RAM to compile. +## Installing + +Instead of building from source shellcheck can be installed through your +systems package manager. + +On OS X: + + $ brew install shellscript ## Building with Cabal From e0d3c6923a82642e0eb3d49a2913ad12e200c379 Mon Sep 17 00:00:00 2001 From: Joshua Appelman Date: Sun, 8 Jun 2014 01:42:32 +0200 Subject: [PATCH 2/2] Removes trailing whitespace. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cd369a5..557e9f3 100644 --- a/README.md +++ b/README.md @@ -53,14 +53,14 @@ Let cabal update itself, in case your distro version is outdated: With cabal installed, cd to the ShellCheck source directory and: $ cabal install - + This will install ShellCheck to your ~/.cabal/bin directory. Add the directory to your PATH (for bash, add this to your ~/.bashrc file): export PATH=$HOME/.cabal/bin:$PATH -Verify that your PATH is set up correctly: +Verify that your PATH is set up correctly: $ which shellcheck ~/.cabal/bin/shellcheck