From 95a3be6546ff18f8223d2f12a3fe0196c1171ebf Mon Sep 17 00:00:00 2001 From: Vidar Holen Date: Sat, 8 Feb 2014 09:58:11 -0800 Subject: [PATCH] README: Updated URL, reformatted long lines --- README | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/README b/README index 2257a19..66383d3 100644 --- a/README +++ b/README @@ -1,7 +1,7 @@ ShellCheck - A shell script static analysis tool -http://www.vidarholen.net/contents/shellcheck +http://www.shellcheck.net -Copyright 2012, Vidar 'koala_man' Holen +Copyright 2012-2014, Vidar 'koala_man' Holen Licensed under the GNU Affero General Public License, v3 The goals of ShellCheck are: @@ -15,17 +15,20 @@ 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 and Text.Regex. -To build the JSON interface and run the unit tests, it also requires QuickCheck2 and JSON. +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 cabal-install ghc ghc-parsec-devel ghc-QuickCheck-devel ghc-json-devel ghc-regex-compat-devel + yum install cabal-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 cabal-install + apt-get install ghc libghc-parsec3-dev libghc-json-dev \ + libghc-regex-compat-dev libghc-quickcheck2-dev cabal-install For older releases, you may have to use: - apt-get install ghc6 libghc6-parsec3-dev libghc6-quickcheck2-dev libghc6-json-dev libghc-regex-compat-dev 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: brew install cabal-install @@ -36,9 +39,9 @@ On Mac OS X with MacPorts (http://www.macports.org/), use: Executables can be built with cabal. Tests currently still rely on a Makefile. Install: - cabal install - - which shellcheck + $ cabal install + ... + $ which shellcheck ~/.cabal/bin/shellcheck Happy ShellChecking!