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

Updated readme

This commit is contained in:
Vidar Holen 2014-06-07 23:25:01 -07:00
parent d9c622ae33
commit d13253973b
1 changed files with 17 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -20,16 +20,28 @@ ShellCheck is written in Haskell, and requires at least 1 GB of RAM to compile.
## Installing ## Installing
Instead of building from source shellcheck can be installed through your On systems with Cabal:
systems package manager.
On OS X: cabal update
cabal install shellcheck
$ brew install shellscript On Arch Linux with community packages enabled:
pacman -S shellcheck
On OS X with homebrew:
brew install shellcheck
ShellCheck is also available as an online service:
http://www.shellcheck.net
## Building with Cabal ## Building with Cabal
Make sure cabal is installed. On Debian based distros: This sections describes how to build ShellCheck from a source directory.
First, make sure cabal is installed. On Debian based distros:
apt-get install cabal-install apt-get install cabal-install
@ -73,26 +85,4 @@ To run the unit test suite:
cabal build cabal build
cabal test cabal test
## Building with Make
ShellCheck requires GHC, Parsec3, JSON and Text.Regex.
On Fedora, these can be installed with:
yum install ghc ghc-parsec-devel ghc-QuickCheck-devel \
ghc-json-devel ghc-regex-compat-devel pandoc
On Ubuntu and similar, use:
apt-get install ghc libghc-parsec3-dev libghc-json-dev \
libghc-regex-compat-dev libghc-quickcheck2-dev pandoc
To build, cd to the shellcheck source directory and:
$ make
If you want to distribute the binary and/or run it on other distros, you
can `make shellcheck-static` to build a statically linked executable without
library dependencies.
Happy ShellChecking! Happy ShellChecking!