Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 59 lines (40 sloc) 1.843 kb
110b105 David Terei Update pretty cabal file, readme and changelog for 1.1.1.1.
dterei authored
1 # Pretty : A Haskell Pretty-printer library
2
334adf8 David Terei fixes to hackage badge in readme
dterei authored
3 [![Hackage version](https://img.shields.io/hackage/v/pretty.svg?style=flat)](https://hackage.haskell.org/package/pretty) [![Build Status](https://img.shields.io/travis/haskell/pretty.svg?style=flat)](https://travis-ci.org/haskell/pretty)
2832850 David Terei update readme to include badges
dterei authored
4
110b105 David Terei Update pretty cabal file, readme and changelog for 1.1.1.1.
dterei authored
5 Pretty is a pretty-printing library, a set of API's that provides a
6 way to easily print out text in a consistent format of your choosing.
7 This is useful for compilers and related tools.
8
9 It is based on the pretty-printer outlined in the paper 'The Design
2c41eb0 David Terei Fix paper link.
dterei authored
10 of a Pretty-printing Library' by John Hughes in Advanced Functional
11 Programming, 1995. It can be found
12 [here](http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.38.8777).
13
110b105 David Terei Update pretty cabal file, readme and changelog for 1.1.1.1.
dterei authored
14 ## Licensing
54b2934 Add a readme file
David Terei authored
15
110b105 David Terei Update pretty cabal file, readme and changelog for 1.1.1.1.
dterei authored
16 This library is BSD-licensed.
a75ee60 Restructure code base.
David Terei authored
17
110b105 David Terei Update pretty cabal file, readme and changelog for 1.1.1.1.
dterei authored
18 ## Building
19
20 The library uses the Cabal build system, so building is simply a
0e24600 David Terei update readme to reflect use of branches in git
dterei authored
21 matter of running:
110b105 David Terei Update pretty cabal file, readme and changelog for 1.1.1.1.
dterei authored
22
23 ```
0e24600 David Terei update readme to reflect use of branches in git
dterei authored
24 cabal sandbox init
25 cabal install "QuickCheck >= 2.5 && < 3"
26 cabal install --only-dependencies
110b105 David Terei Update pretty cabal file, readme and changelog for 1.1.1.1.
dterei authored
27 cabal configure --enable-tests
28 cabal build
0e24600 David Terei update readme to reflect use of branches in git
dterei authored
29 cabal test
110b105 David Terei Update pretty cabal file, readme and changelog for 1.1.1.1.
dterei authored
30 ```
31
0e24600 David Terei update readme to reflect use of branches in git
dterei authored
32 We have to install `QuickCheck` manually as otherwise Cabal currently
33 throws an error due to the cyclic dependency between `pretty` and
34 `QuickCheck`.
335acba Update readme to note branches used by development
David Terei authored
35
f6b2e75 David Terei work around bug with `cabal test`
dterei authored
36 *If `cabal test` freezes*, then run
37 `cabal test --show-details=streaming` instead. This is due to a
38 [bug](https://github.com/haskell/cabal/issues/1810) in certain
39 versions of Cabal.
40
110b105 David Terei Update pretty cabal file, readme and changelog for 1.1.1.1.
dterei authored
41 ## Get involved!
42
43 We are happy to receive bug reports, fixes, documentation enhancements,
44 and other improvements.
45
46 Please report bugs via the
47 [github issue tracker](http://github.com/haskell/pretty/issues).
48
49 Master [git repository](http://github.com/haskell/pretty):
50
51 * `git clone git://github.com/haskell/pretty.git`
52
53 ## Authors
54
55 This library is maintained by David Terei, <code@davidterei.com>. It
56 was originally designed by John Hughes's and since heavily modified by
57 Simon Peyton Jones.
58
Something went wrong with that request. Please try again.