diff options
| author | fiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b> | 2006-10-29 19:58:20 +0000 |
|---|---|---|
| committer | fiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b> | 2006-10-29 19:58:20 +0000 |
| commit | 362eec5a4d1a0e7850d45b2e9196b30e489dc99d (patch) | |
| tree | 96254526cb8a3e79b35bca17504de0e225db4c0f /INSTALL | |
| parent | 6bb5548ec3948e99fd68773bf6e0d9a79f7f266c (diff) | |
* Extracted installation instructions from README into a separate file,
INSTALL. Reason: Only those who install from source will need the
information in INSTALL, so it does not need to be included in user
documentation. Indeed, it might confuse people who install Pandoc by some
other method.
* Minor changes in README (using "Pandoc" as a generic name for the
system, "'pandoc'" as a name for the executable).
git-svn-id: https://pandoc.googlecode.com/svn/trunk@36 788f1e2b-df1e-0410-8736-df70ead52e1b
Diffstat (limited to 'INSTALL')
| -rw-r--r-- | INSTALL | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL new file mode 100644 index 000000000..964559f85 --- /dev/null +++ b/INSTALL @@ -0,0 +1,58 @@ +% Installing Pandoc + +# Installing GHC + +To compile Pandoc, you'll need [GHC] version 6.4 or greater. + +If you don't have GHC already, you can get it from the +[GHC Download] page. + +[GHC]: http://www.haskell.org/ghc/ +[GHC Download]: http://www.haskell.org/ghc/download.html + +You'll also need standard build tools: GNU `make`, `sed`, `bash`, and `perl`. +These are standard on unix systems (including MacOS X). If you're +using Windows, you can install [Cygwin]. + +[Cygwin]: http://www.cygwin.com/ + +# Installing Pandoc + +1. Change to the directory containing the Pandoc distribution. + +2. Compile: + + make + +3. See if it worked (optional, but recommended): + + make test + +4. Install: + + make install + + Note: This installs `pandoc`, together with its wrappers and + documentation, into the `/usr/local` directory, which requires root + privileges. If you don't have root privileges or would prefer to + install `pandoc` and the associated shell scripts into your `~/bin` + directory, type this instead: + + PREFIX=~ make install-exec + +5. Install everthing, including Haskell libraries and library documentation + (optional): + + make install-all + +# Removing Pandoc + +Each of the installation steps described above can be reversed: + + make uninstall + + PREFIX=~ make uninstall-exec + + make uninstall-all + + |