diff --git a/README b/README.md similarity index 75% rename from README rename to README.md index 66383d3..24bf0c4 100644 --- a/README +++ b/README.md @@ -1,4 +1,5 @@ -ShellCheck - A shell script static analysis tool +# ShellCheck - A shell script static analysis tool + http://www.shellcheck.net Copyright 2012-2014, Vidar 'koala_man' Holen @@ -19,29 +20,35 @@ 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 \ + + 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 \ + + 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 \ + + 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 + + brew install cabal-install On Mac OS X with MacPorts (http://www.macports.org/), use: - port install hs-cabal-install + + port install hs-cabal-install Executables can be built with cabal. Tests currently still rely on a Makefile. Install: - $ cabal install - ... - $ which shellcheck - ~/.cabal/bin/shellcheck + + $ cabal install + ... + $ which shellcheck + ~/.cabal/bin/shellcheck Happy ShellChecking!