Added a simple README file

This commit is contained in:
Yann Esposito (Yogsototh) 2013-11-15 17:01:30 +01:00
parent 846ab20c6a
commit dec7358f95

27
README.md Normal file
View file

@ -0,0 +1,27 @@
# Holy Haskell
This very simple script will initialize your new Haskell project.
It will initialize the `.gitignore` file, the cabal file and give an
example of test suite.
# Usage
Clone the repository locally and launch the script:
```
./holy-haskell.sh
```
It will ask some questions, do your best dear aventurer!
## dependencies
- [Haskell](http://haskell.org/platform)
- [`cabal`](http://haskell.org/cabal) version at least 1.18 ; to install it:
```
cabal update
cabal install cabal-install
```
- [`git`](http://git-scm.org)
- [`zsh`](http://zsh.org) which should be already installed on most platform