Permalink
Browse files

Update pretty cabal file, readme and changelog for 1.1.1.1.

  • Loading branch information...
1 parent bf3cbed commit 110b105c491387a73dd37b4f86a686ed131767b2 @dterei dterei committed Oct 27, 2013
Showing with 58 additions and 30 deletions.
  1. +9 −11 CHANGELOG → CHANGELOG.md
  2. +46 −16 README.md
  3. +3 −3 pretty.cabal
View
@@ -1,8 +1,11 @@
-======== CHANGE LOG ==========
+# Pretty library change log
-Pretty library change log.
+## 1.1.1.1
-========= Version 4.0, 24 August 2011 ==========
+* Update pretty cabal file and readme.
+* Fix tests to work with latest quickcheck.
+
+## Version 4.0, 24 August 2011
* Big change to the structure of the library. Now we don't have a fixed
TextDetails data type for storing the various String types that we
@@ -15,7 +18,7 @@ Pretty library change log.
module uses it to implement the old API. The Text.PrettyPrint.HughesPJ
module has been left unchanged for a compatability module but deprecated.
-========= Version 3.0, 28 May 1987 ==========
+## Version 3.0, 28 May 1987
* Cured massive performance bug. If you write:
@@ -75,9 +78,7 @@ Pretty library change log.
-> IO () -> IO ()), rather than producing a string that you then
print.
-
-
-========= Version 3.0, 28 May 1987 ==========
+## Version 3.0, 28 May 1987
* Made empty into a left unit for <> as well as a right unit;
it is also now true that
@@ -90,9 +91,7 @@ Pretty library change log.
* Corrected and tidied up the laws and invariants
-
-
-========= Version 1.0 ==========
+## Version 1.0
Relative to John's original paper, there are the following new features:
@@ -166,4 +165,3 @@ Relative to John's original paper, there are the following new features:
6. Numerous implementation tidy-ups
Use of unboxed data types to speed up the implementation
-
View
@@ -1,24 +1,54 @@
-Pretty : A Haskell Pretty-printer library
-------------------------------------------------------------------------------
-This repository contains a pretty-printing library, a set of API's that
-provides a way to easily print out text in a consistent format of your
-choosing. This is useful for compilers and related tools. The library was
-originally designed by John Hughes's and has since been heavily modified by
-Simon Peyton Jones.
+# Pretty : A Haskell Pretty-printer library
+
+Pretty is a pretty-printing library, a set of API's that provides a
+way to easily print out text in a consistent format of your choosing.
+This is useful for compilers and related tools.
+
+It is based on the pretty-printer outlined in the paper 'The Design
+of a Pretty-printing Library' in Advanced Functional Programming,
+Johan Jeuring and Erik Meijer (eds), LNCS 925
+<http://www.cs.chalmers.se/~rjmh/Papers/pretty.ps>
+
+## Licensing
-It is based on the pretty-printer outlined in the paper 'The Design of a
-Pretty-printing Library' in Advanced Functional Programming, Johan Jeuring and
-Erik Meijer (eds), LNCS 925 <http://www.cs.chalmers.se/~rjmh/Papers/pretty.ps>
+This library is BSD-licensed.
-The library uses the Cabal build system, so building is simply a matter of
-running 'cabal install' or 'cabal configure && cabal build'.
+## Building
+
+The library uses the Cabal build system, so building is simply a
+matter of running
+
+```
+cabal configure --enable-tests
+cabal build
+```
+
+## Branches
Usually two branches are maintained for Pretty development:
- * master: This branch is generally kept in a stable state and is where
- release are pulled and made from. The reason for this is GHC includes
- the pretty library and tracks the master branch by default so we don't
- want experimental code being pulled into GHC at times.
+ * master: This branch is generally kept in a stable state and is
+ where release are pulled and made from. The reason for this is GHC
+ includes the pretty library and tracks the master branch by default
+ so we don't want experimental code being pulled into GHC at times.
* next: This branch is the general development branch.
+## Get involved!
+
+We are happy to receive bug reports, fixes, documentation enhancements,
+and other improvements.
+
+Please report bugs via the
+[github issue tracker](http://github.com/haskell/pretty/issues).
+
+Master [git repository](http://github.com/haskell/pretty):
+
+* `git clone git://github.com/haskell/pretty.git`
+
+## Authors
+
+This library is maintained by David Terei, <code@davidterei.com>. It
+was originally designed by John Hughes's and since heavily modified by
+Simon Peyton Jones.
+
View
@@ -13,12 +13,12 @@ description:
license: BSD3
license-file: LICENSE
category: Text
-maintainer: David Terei <dave.terei@gmail.com>
+maintainer: David Terei <code@davidterei.com>
homepage: http://github.com/haskell/pretty
bug-reports: http://github.com/haskell/pretty/issues
stability: Stable
build-type: Simple
-Extra-Source-Files: README CHANGELOG
+Extra-Source-Files: README.md CHANGELOG.md
Cabal-Version: >= 1.8
source-repository head
@@ -39,7 +39,7 @@ Test-Suite test-pretty
hs-source-dirs: tests
src
build-depends: base >= 3 && < 5,
- QuickCheck == 2.*
+ QuickCheck >= 2.5 && <3
main-is: Test.hs
other-modules:
TestGenerators

0 comments on commit 110b105

Please sign in to comment.