Updated INSTALL with instructions for compiling in syntax highlighting support.

git-svn-id: https://pandoc.googlecode.com/svn/trunk@1223 788f1e2b-df1e-0410-8736-df70ead52e1b

1 files changed, 43 insertions, 31 deletions

diff --git a/INSTALL b/INSTALL
index 9e5aa75fe..48792253c 100644
--- a/INSTALL
+++ b/INSTALL
@@ -96,6 +96,49 @@ Installing Pandoc
 
 [haddock]: http://www.haskell.org/haddock/ 
 
+Installing pandoc using Cabal
+-----------------------------
+
+Pandoc can also be installed using the standard Haskell packaging tool,
+[Cabal](http://www.haskell.org/cabal/).  You'll need GHC 6.6 or greater
+(see [Installing GHC](#installing-ghc), above). Just download the source
+tarball, unpack, and type:
+
+    runhaskell Setup.hs configure
+    runhaskell Setup.hs build
+    runhaskell Setup.hs haddock  # optional, to build library documentation
+    runhaskell Setup.hs install  # this one as root
+
+This will install the pandoc executable and the Haskell libraries,
+but not the shell scripts, man pages, or other documentation.
+
+Note:  If you are using GHC 6.6.*, you will need to start by
+replacing `pandoc.cabal` with a version suitable for GHC 6.6:
+
+    cp pandoc.cabal pandoc.cabal.orig
+    cp pandoc.cabal.ghc66 pandoc.cabal 
+
+Optional syntax highlighting support
+------------------------------------
+
+Pandoc can optionally be compiled with support for syntax highlighting of
+delimited code blocks.  This feature requires the [`highlighting-kate` library].
+It also requires Cabal version 1.2 or greater.
+
+If you are using Cabal to compile pandoc, specify the `highlighting` flag in
+the configure step:
+
+    runhaskell Setup.hs configure -fhighlighting
+
+If you are using the Makefile:
+
+    CABALOPTS=-fhighlighting make
+
+If you have already built pandoc, you may need to do a `make clean` or
+`runhaskell Setup.hs clean` first.
+
+[`highlighting-kate` library]: http://johnmacfarlane.net/highlighting-kate
+
 Removing Pandoc
 ---------------
 
@@ -156,36 +199,6 @@ but are documented here for packagers and developers:
   which must be created by building Pandoc on a Windows machine).
 * `website`:  Creates Pandoc's website in `web/pandoc` directory.
 
-Installing pandoc using Cabal
-=============================
-
-Pandoc can also be installed using the standard Haskell packaging tool,
-[Cabal](http://www.haskell.org/cabal/).  You'll need GHC 6.6 or greater
-(see [Installing GHC](#installing-ghc), above). Just download the source
-tarball, unpack, and type:
-
-    runhaskell Setup.hs configure
-    runhaskell Setup.hs build
-    runhaskell Setup.hs install  # this one as root
-
-This will install the pandoc executable and the Haskell libraries,
-but not the shell scripts, man pages, or other documentation.
-
-Notes:
-
-1.  If you've checked out the source from the subversion repository rather
-    than getting it from a release tarball, you'll need to do:
-
-        make templates
-
-    before you can build pandoc using the above commands.
-
-2.  If you are using GHC 6.6.*, you will need to start by
-    replacing `pandoc.cabal` with a version suitable for GHC 6.6:
-
-        cp pandoc.cabal pandoc.cabal.orig
-        cp pandoc.cabal.ghc66 pandoc.cabal 
-
 Installing pandoc using MacPorts
 ================================
 
@@ -249,4 +262,3 @@ Arch linux repository.  Arch users can install `pandoc` by typing
 
     pacman -Sy pandoc
 
-