From d4059c30b7739d5f6ac5d94433680ac99dd278d3 Mon Sep 17 00:00:00 2001 From: Andrew Pennebaker Date: Fri, 14 Mar 2014 16:37:34 -0400 Subject: [PATCH 1/2] readme: markdown for link rendering --- README => README.md | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) rename README => README.md (75%) 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! From f92f93468815dc71be971bd017ea3351c8738c6f Mon Sep 17 00:00:00 2001 From: Andrew Pennebaker Date: Sat, 15 Mar 2014 16:49:05 -0400 Subject: [PATCH 2/2] readme: added compiler memory note --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 24bf0c4..957d9a0 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,8 @@ The goals of ShellCheck are: 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. + On Fedora, these can be installed with: yum install cabal-install ghc ghc-parsec-devel ghc-QuickCheck-devel \