docs: typo
[cabal.git] / README.md
blobda10194360a0b78e3f53fac33dcbae2d23d269a4
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-install](cabal-install/README.md): the package containing the `cabal` tool ([license](cabal-install/LICENSE))
16 The canonical upstream repository is located at
17 https://github.com/haskell/cabal.
19 Installing cabal-install (by downloading the binary)
20 ----------------------------------------------------
22 Prebuilt binary releases can be obtained from https://www.haskell.org/cabal/download.html.
23 The `cabal-install` binary download for your platform should contain the `cabal` executable.
25 Installing cabal-install (preferred, with cabal-install)
26 --------------------------------------------------------
28 Assuming that you have a pre-existing, recent version of `cabal-install`, run:
30 ~~~~
31 cabal install cabal-install
32 ~~~~
34 To get the latest version of `cabal-install`. (You may want to `cabal update` first.)
36 To install the latest version from the Git repository, clone the
37 Git repository and then run:
39 ~~~~
40 cabal install --project-file=cabal.project.release cabal-install
41 ~~~~
43 Installing cabal-install without cabal-install
44 ----------------------------------------------
46 Assuming you don't have a pre-existing copy of `cabal-install`,
47 look into [`bootstrap`](bootstrap) directory.