git.iko.soy/typeable/pandoc
on master help sign in
Updated INSTALL in light of new dependencies (utf8-string and zip-archive).

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

commit2cecca73ea76f4c18ddd64be738ad709a321a30c authorfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b> dateSat 6 Sep 2008, 18:33 (18 years ago) parentfc24c79
1 file changed+36−2
INSTALL+36−2
INSTALL+36−2
@@ -20,7 +20,7 @@ to to [install Cabal] separately. You can check your Cabal version using
2020If you're running MacOS X, you can also install GHC using [MacPorts] or [Fink].
2121
2222If you're on a [debian]-based linux system (such as [Ubuntu]), you can get
23−GHC and the required libraries using `apt-get`:
23+GHC and some required libraries using `apt-get`:
2424
2525 sudo apt-get install ghc6 libghc6-xhtml-dev libghc6-mtl-dev libghc6-network-dev
2626
@@ -33,6 +33,31 @@ GHC and the required libraries using `apt-get`:
3333[Ubuntu]: http://www.ubuntu.com
3434[debian]: http://www.debian.org/
3535
36+Installing prerequisites
37+------------------------
38+
39+Pandoc needs the `utf8-string` and `zip-archive` to compile.
40+Check your packaging system to see if they are included.
41+If not, you will need to compile them from source.
42+
43+On \*nix systems, the easiest way to do this is to install
44+the [cabal-install] tool. See the section [Quick Installation
45+on Unix] for instructions.
46+
47+[cabal-install]: http://hackage.haskell.org/trac/hackage/wiki/CabalInstall
48+[Quick Installation on Unix]: http://hackage.haskell.org/trac/hackage/wiki/CabalInstall#QuickInstallationonUnix
49+
50+Once you've got `cabal-install` installed, you can install the
51+needed libraries by doing
52+
53+ cabal install utf8-string
54+ cabal install zip-archive
55+
56+Alternatively, you can install these libraries using the [standard
57+Cabal method], but you will have to install their dependencies manually.
58+
59+[standard Cabal method]: http://haskell.org/haskellwiki/Cabal/How_to_install_a_Cabal_package
60+
3661Getting the source
3762------------------
3863
@@ -63,6 +88,14 @@ Installing Pandoc using Make
6388 If you get "Unknown modifier" errors, it is probably because `make`
6489 on your system is not [GNU `make`]. Try using `gmake` instead.
6590
91+ If you get a message saying that the `zip-archive` or `utf8-string`
92+ libraries cannot be found, and you have installed these using
93+ `cabal-install`, it is probably because by default `cabal-install`
94+ installs libraries to the user's directory rather than globally.
95+ Try again with
96+
97+ CABALOPTS=--user make
98+
66993. See if it worked (optional, but recommended):
67100
68101 make test
@@ -117,7 +150,8 @@ Installing pandoc using Cabal
117150
118151Change to the directory containing the pandoc source, and type:
119152
120− runhaskell Setup.hs configure
153+ runhaskell Setup.hs configure # add --user if you have installed
154+ # prerequisites locally with cabal-install
121155 runhaskell Setup.hs build
122156 runhaskell Setup.hs haddock # optional, to build library documentation
123157 runhaskell Setup.hs install # this one as root or sudo