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

Fixed up README

This commit is contained in:
Vidar Holen 2014-03-19 09:57:01 -07:00
parent 4f1fd43360
commit 902cb9c303
1 changed files with 30 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -16,41 +16,53 @@ 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, JSON and ShellCheck requires at least 1 GB of RAM to compile. Executables can be built with cabal. Tests currently still rely on a Makefile.
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: ## Building with Cabal
yum install cabal-install ghc ghc-parsec-devel ghc-QuickCheck-devel \ Make sure cabal is installed. On Debian based distros:
ghc-json-devel ghc-regex-compat-devel
On Ubuntu and similar, use: apt-get install cabal-install
apt-get install ghc libghc-parsec3-dev libghc-json-dev \ On Fedora:
libghc-regex-compat-dev libghc-quickcheck2-dev cabal-install
For older releases, you may have to use: yum install cabal-install
apt-get install ghc6 libghc6-parsec3-dev libghc6-quickcheck2-dev \ On Mac OS X with homebrew (http://brew.sh/):
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: On Mac OS X with MacPorts (http://www.macports.org/):
port install hs-cabal-install port install hs-cabal-install
Executables can be built with cabal. Tests currently still rely on a Makefile. With cabal installed, cd to the shellcheck source directory and:
Install:
$ cabal install $ cabal install
... ...
$ which shellcheck $ which shellcheck
~/.cabal/bin/shellcheck ~/.cabal/bin/shellcheck
## Building with Make
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 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
To build and run the tests, cd to the shellcheck source directory and:
$ make
Happy ShellChecking! Happy ShellChecking!