cabal init -i should sanitize suggested package name (fix #8404) (#8561)
[cabal.git] / Cabal-syntax / README.md
blobcb99814a19841619cd6a215b2c85e034cde028db
1 The Cabal-syntax package
2 ========================
4 See the [Cabal web site] for more information.
6 The `Cabal-syntax` package defines the syntax of the `.cabal` file format
7 and provides tools for parsing `.cabal` files.
9 More information
10 ================
12 Please see the [Cabal web site] for the [user guide] and [API
13 documentation]. There is additional information available on the
14 [development wiki].
16 [user guide]:        http://www.haskell.org/cabal/users-guide
17 [API documentation]: http://www.haskell.org/cabal/release/cabal-latest/doc/API/Cabal/Distribution-Simple.html
18 [development wiki]:  https://github.com/haskell/cabal/wiki
21 Bugs
22 ====
24 Please report bugs and feature requests to Cabal's [bug tracker].
27 Your help
28 ---------
30 To help Cabal's development, it is enormously helpful to know from
31 Cabal's users what their most pressing problems are with Cabal and
32 [Hackage]. You may have a favourite Cabal bug or limitation. Look at
33 Cabal's [bug tracker]. Ensure that the problem is reported there and
34 adequately described. Comment on the issue to report how much of a
35 problem the bug is for you. Subscribe to the issue's notifications to
36 discuss requirements and keep informed on progress. For feature
37 requests, it is helpful if there is a description of how you would
38 expect to interact with the new feature.
40 [Hackage]: http://hackage.haskell.org
43 Source code
44 ===========
46 You can get the master development branch using:
48     $ git clone https://github.com/haskell/cabal.git
51 Credits
52 =======
54 See the `AUTHORS` file.
56 Authors of the [original Cabal
57 specification](https://www.haskell.org/cabal/proposal/pkg-spec.pdf):
59 - Isaac Jones
60 - Simon Marlow
61 - Ross Patterson
62 - Simon Peyton Jones
63 - Malcolm Wallace
66 [bug tracker]: https://github.com/haskell/cabal/issues
67 [Cabal web site]: http://www.haskell.org/cabal/