haskell / cabal

# Cabal
This Cabal Git repository contains the following main packages:
 * Cabal: the Cabal library package (license)
 * Cabal-hooks: the library providing an API for the Cabal `Hooks` build type (license)
 * Cabal-syntax: the `.cabal` file format library (license)
 * cabal-install: the package containing the `cabal` tool (license)
 * cabal-install-solver: the package containing the solver component of the `cabal` tool (license)
The canonical upstream repository is located at
https://github.com/haskell/cabal.
Proposals for the Cabal project
-------------------------------
The proposals process is the mechanism which developers can gain
the necessary consensus to make larger changes to the Cabal ecosystem.
* It is light-weight, a PR is opened and discussed on cabal-proposals repo with a fixed discussion period.
* It is developer-led, final decisions are made by developers at the Cabal developers meeting.
* It is flexible, there is no formal voting procedure, decisions are made by rough consensus.
Ways to get the `cabal-install` binary
--------------------------------
1. _GHCup_ (**preferred**): get GHCup using the directions on its website and run:
 [code] 
2. _Download from official website_:
 the `cabal-install` binary download for your platform should contain the `cabal` executable.
#### Preview Releases
_Getting unreleased versions of `cabal-install`_: gives you a chance to try out yet-unreleased features.
Currently, we only provide binaries for `x86_64` platforms.
1. _GitHub preview release built from the tip of the `master` branch_: download from GitHub or use this GHCup command to install:
 [code] 
 Replace "Linux" with "Windows" or "macOS" as appropriate.
 The default Linux build is dynamically linked against `zlib`, `gmp` and `glibc`.
 You will need to have appropriate versions of these libraries installed to use it.
 Alternatively a statically linked "Linux-static" binary is also provided.
 You might need to add the following to your `cabal.project` file
 if your build fails because of an out-of-date `Cabal` library:
 [code] 
2. Even more cutting-edge binaries built from pull requests are always available
 from the `Validate` workflow page on GitHub, at the very bottom of the page,
 or from the `build-alpine` workflow for statically linked Linux builds.
Ways to build `cabal-install` for everyday use
--------------------------------------------
1. _With cabal-install_:
 if you have a pre-existing version of `cabal-install`, run:
 [code] 
 to get the latest version of `cabal-install`. (You may want to `cabal update` first.)
2. _From Git_:
 again with a pre-existing version of `cabal-install`,
 you can install the latest version from the Git repository. Clone the
 Git repository, move to its root, and run:
 [code] 
3. _Bootstrapping_:
 if you don't have a pre-existing version of `cabal-install`,
 look into the `bootstrap` directory.
Learn how to use `cabal` and get support
----------------------------------------
`cabal` comes with a thorou