Update readme to note branches used by development
authorDavid Terei <davidterei@gmail.com>
Sun, 6 Nov 2011 23:02:23 +0000 (15:02 -0800)
committerDavid Terei <davidterei@gmail.com>
Sun, 6 Nov 2011 23:02:23 +0000 (15:02 -0800)
README

diff --git a/README b/README
index 787506a..b07e76c 100644 (file)
--- a/README
+++ b/README
@@ -9,3 +9,12 @@ Simon Peyton Jones.
 The library uses the Cabal build system, so building is simply a matter of
 running 'cabal install' or 'cabal configure && cabal build'.
 
+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.
+
+ * next: This branch is the general development branch.
+