cabal init -i should sanitize suggested package name (fix #8404) (#8561)
[cabal.git] / Cabal / README.md
blob6243422a2ce5c55afae78d3ad928f93b469394bb
1 The Cabal library package
2 =========================
4 See the [Cabal web site] for more information.
6 If you also want the `cabal` command-line program, you need the
7 [cabal-install] package in addition to this library.
9 [cabal-install]: ../cabal-install
11 More information
12 ================
14 Please see the [Cabal web site], the [user guide] and the [API
15 documentation]. There is additional information available on the
16 [development wiki].
18 [user guide]:        http://www.haskell.org/cabal/users-guide
19 [API documentation]: https://hackage.haskell.org/package/Cabal/docs/Distribution-Simple.html
20 [development wiki]:  https://github.com/haskell/cabal/wiki
23 Bugs
24 ====
26 Please report bugs and feature requests to Cabal's [bug tracker].
29 Your help
30 ---------
32 To help Cabal's development, it is enormously helpful to know from
33 Cabal's users what their most pressing problems are with Cabal and
34 [Hackage]. You may have a favourite Cabal bug or limitation. Look at
35 Cabal's [bug tracker]. Ensure that the problem is reported there and
36 adequately described. Comment on the issue to report how much of a
37 problem the bug is for you. Subscribe to the issues's notifications to
38 discussed requirements and keep informed on progress. For feature
39 requests, it is helpful if there is a description of how you would
40 expect to interact with the new feature.
42 [Hackage]: http://hackage.haskell.org
45 Source code
46 ===========
48 You can get the master development branch using:
50     $ git clone https://github.com/haskell/cabal.git
53 Credits
54 =======
56 See the `AUTHORS` file.
58 Authors of the [original Cabal
59 specification](https://www.haskell.org/cabal/proposal/pkg-spec.pdf):
61 - Isaac Jones
62 - Simon Marlow
63 - Ross Patterson
64 - Simon Peyton Jones
65 - Malcolm Wallace
68 [bug tracker]: https://github.com/haskell/cabal/issues
69 [Cabal web site]: http://www.haskell.org/cabal/