cabal haddock imply enable-documentation
[cabal.git] / README.md
blob1c82d7cab05ba5e1c248fe60bb4c8e20ef3013b5
1 # Cabal
3 [![Hackage version](https://img.shields.io/hackage/v/Cabal.svg?label=Hackage)](https://hackage.haskell.org/package/Cabal)
4 [![Stackage version](https://www.stackage.org/package/Cabal/badge/lts?label=Stackage)](https://www.stackage.org/package/Cabal)
5 [![Documentation Status](http://readthedocs.org/projects/cabal/badge/?version=latest)](http://cabal.readthedocs.io/en/latest/?badge=latest)
6 [![IRC chat](https://img.shields.io/badge/chat-via%20libera-brightgreen.svg)](https://web.libera.chat/#hackage)
7 [![Matrix chat](https://img.shields.io/badge/chat-via%20matrix-brightgreen.svg)](https://matrix.to/#/#hackage:libera.chat)
9 <img src="https://www.haskell.org/cabal/images/Cabal-light.png" align="right">
11 This Cabal Git repository contains the following packages:
13  * [Cabal](Cabal/README.md): the Cabal library package ([license](Cabal/LICENSE))
14  * [Cabal-syntax](Cabal-syntax/README.md): the `.cabal` file format library ([license](Cabal-syntax/LICENSE))
15  * [cabal-install](cabal-install/README.md): the package containing the `cabal` tool ([license](cabal-install/LICENSE))
17 The canonical upstream repository is located at
18 https://github.com/haskell/cabal.
20 Installing cabal-install (by downloading the binary)
21 ----------------------------------------------------
23 Prebuilt binary releases can be obtained from https://www.haskell.org/cabal/download.html.
24 The `cabal-install` binary download for your platform should contain the `cabal` executable.
26 Installing cabal-install (preferred, with cabal-install)
27 --------------------------------------------------------
29 Assuming that you have a pre-existing, recent version of `cabal-install`, run:
31 ```
32 cabal install cabal-install
33 ```
35 To get the latest version of `cabal-install`. (You may want to `cabal update` first.)
37 To install the latest version from the Git repository, clone the
38 Git repository and then run:
40 ```
41 cabal install --project-file=cabal.project.release cabal-install
42 ```
44 Installing cabal-install without cabal-install
45 ----------------------------------------------
47 Assuming you don't have a pre-existing copy of `cabal-install`,
48 look into [`bootstrap`](bootstrap) directory.