7x31
/
shellcheck
mirror of https://github.com/koalaman/shellcheck.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

README: Updated URL, reformatted long lines

This commit is contained in:
Vidar Holen 2014-02-08 09:58:11 -08:00
parent 968e34e002
commit 95a3be6546
1 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README
View File

@ -1,7 +1,7 @@
ShellCheck - A shell script static analysis tool 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 Licensed under the GNU Affero General Public License, v3
The goals of ShellCheck are: 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 - To point out subtle caveats, corner cases and pitfalls, that may cause an
advanced user's otherwise working script to fail under future circumstances. advanced user's otherwise working script to fail under future circumstances.
ShellCheck is written in Haskell, and requires GHC, Parsec3 and Text.Regex. ShellCheck is written in Haskell, and requires GHC, Parsec3, JSON and
To build the JSON interface and run the unit tests, it also requires QuickCheck2 and JSON. Text.Regex. To run the unit tests, it also requires QuickCheck2.
On Fedora, these can be installed with: 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: 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: 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: On Mac OS X with homebrew (http://brew.sh/), use:
brew install cabal-install 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. Executables can be built with cabal. Tests currently still rely on a Makefile.
Install: Install:
cabal install $ cabal install
...
which shellcheck $ which shellcheck
~/.cabal/bin/shellcheck ~/.cabal/bin/shellcheck
Happy ShellChecking! Happy ShellChecking!