7x31/shellcheck
1
0
Fork 0
mirror of https://github.com/koalaman/shellcheck.git synced 2025-08-08 20:20:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

readme: markdown for link rendering

Browse Source
This commit is contained in:
Andrew Pennebaker
2014-03-14 16:37:34 -04:00
parent b68de7f42b
commit d4059c30b7
1 changed files with 17 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README → README.md
View File

@@ -1,4 +1,5 @@
ShellCheck - A shell script static analysis tool # ShellCheck - A shell script static analysis tool
http://www.shellcheck.net http://www.shellcheck.net
Copyright 2012-2014, Vidar 'koala_man' Holen 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. 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 \
yum install cabal-install ghc ghc-parsec-devel ghc-QuickCheck-devel \
ghc-json-devel ghc-regex-compat-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 \
apt-get install ghc libghc-parsec3-dev libghc-json-dev \
libghc-regex-compat-dev libghc-quickcheck2-dev cabal-install 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 \
apt-get install ghc6 libghc6-parsec3-dev libghc6-quickcheck2-dev \
libghc6-json-dev libghc-regex-compat-dev cabal-install 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
On Mac OS X with MacPorts (http://www.macports.org/), use: 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. Executables can be built with cabal. Tests currently still rely on a Makefile.
Install: Install:
$ cabal install
... $ cabal install
$ which shellcheck ...
~/.cabal/bin/shellcheck $ which shellcheck
~/.cabal/bin/shellcheck
Happy ShellChecking! Happy ShellChecking!