From 902cb9c303ba86785134a9e9cc1b28ecb5cf733b Mon Sep 17 00:00:00 2001
From: Vidar Holen <spam@vidarholen.net>
Date: Wed, 19 Mar 2014 09:57:01 -0700
Subject: [PATCH] Fixed up README

---
 README.md | 48 ++++++++++++++++++++++++++++++------------------
 1 file changed, 30 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index 957d9a0..147b113 100644
--- a/README.md
+++ b/README.md
@@ -16,41 +16,53 @@ The goals of ShellCheck are:
   - To point out subtle caveats, corner cases and pitfalls, that may cause an
     advanced user's otherwise working script to fail under future circumstances.
 
-ShellCheck is written in Haskell, and requires GHC, Parsec3, JSON and
-Text.Regex. To run the unit tests, it also requires QuickCheck2.
+ShellCheck requires at least 1 GB of RAM to compile. Executables can be built with cabal. Tests currently still rely on a Makefile.
 
-ShellCheck requires at least 1 GB of RAM to compile.
 
-On Fedora, these can be installed with:
+## Building with Cabal
 
-    yum install cabal-install ghc ghc-parsec-devel ghc-QuickCheck-devel \
-      ghc-json-devel ghc-regex-compat-devel
+Make sure cabal is installed. On Debian based distros:
 
-On Ubuntu and similar, use:
+    apt-get install cabal-install
 
-    apt-get install ghc libghc-parsec3-dev libghc-json-dev \
-      libghc-regex-compat-dev libghc-quickcheck2-dev cabal-install
+On Fedora:
 
-For older releases, you may have to use:
+    yum install cabal-install
 
-    apt-get install ghc6 libghc6-parsec3-dev libghc6-quickcheck2-dev \
-      libghc6-json-dev libghc-regex-compat-dev cabal-install
-
-On Mac OS X with homebrew (http://brew.sh/), use:
+On Mac OS X with homebrew (http://brew.sh/):
 
     brew install cabal-install
 
-On Mac OS X with MacPorts (http://www.macports.org/), use:
+On Mac OS X with MacPorts (http://www.macports.org/):
 
     port install hs-cabal-install
 
-Executables can be built with cabal. Tests currently still rely on a Makefile.
-
-Install:
+With cabal installed, cd to the shellcheck source directory and:
 
     $ cabal install
     ...
     $ which shellcheck
     ~/.cabal/bin/shellcheck
 
+
+## Building with Make
+
+ShellCheck is written in Haskell, and requires GHC, Parsec3, JSON and
+Text.Regex. To run the unit tests, it also requires QuickCheck2.
+
+On Fedora, these can be installed with:
+
+    yum install ghc ghc-parsec-devel ghc-QuickCheck-devel \
+      ghc-json-devel ghc-regex-compat-devel
+
+On Ubuntu and similar, use:
+
+    apt-get install ghc libghc-parsec3-dev libghc-json-dev \
+      libghc-regex-compat-dev libghc-quickcheck2-dev
+
+To build and run the tests, cd to the shellcheck source directory and:
+
+    $ make
+
+
 Happy ShellChecking!