Commit 6b60e2ce authored by Erik de Castro Lopo's avatar Erik de Castro Lopo
Browse files

Document building cabal from git sources and running the tests.

parent 75e2ce38
# Building Cabal from git cloned sources and running the tests
Building Cabal from from source required the following:
* Glorious/Glasgow Haskell Compiler (ghc).
* An existing (relatively recent) cabal binary (eg obtained as port of the
haskell-platform, bootstrapped from the source tarball on Hackage or installed
from your Linux vendor).
Once you have these, the steps are:
1. Change into the directory where you want to stash the cabal sources, eg:
```
cd $HOME/Git
```
2. Clone the repo and change into the `cabal-install` directory:
```
git clone https://github.com/haskell/cabal.git
cd cabal/cabal-install/
```
3. If you are hacking on Cabal you probaly don't want your development version
to interfere with the `cabal` executable you actually use, so we'll set up and
use a cabal sandbox:
```
cabal sandbox init
```
4. Now add the `Cabal` library and install all the dependencies into the sandbox:
```
cabal sandbox add-source ../Cabal
cabal --enable-tests install --dependencies-only
```
5. Build cabal-install and run the tests:
```
cabal build
cabal test
```
......@@ -5,6 +5,7 @@ This Cabal Git repository contains the following packages:
* [Cabal](Cabal/README.md): the Cabal library package ([license](Cabal/LICENSE))
* [cabal-install](cabal-install/README.md): the package containing the `cabal` tool ([license](cabal-install/LICENSE))
See [BuildingFromGit.md](BuildingFromGit.md) for information about building from git cloned sources.
See [HACKING.md](HACKING.md) for information about contributing.
The canonical upstream repository is located at
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment