diff options
Diffstat (limited to 'INSTALL.md')
| -rw-r--r-- | INSTALL.md | 29 |
1 files changed, 22 insertions, 7 deletions
diff --git a/INSTALL.md b/INSTALL.md index b299653d2..32e71cc3c 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -11,15 +11,15 @@ a zip file that contains pandoc's binaries and documentation. Simply unzip this file and move the binaries to a directory of your choice. + + - Alternatively, you can install pandoc using + [chocolatey](https://chocolatey.org): `choco install pandoc`. - For PDF output, you'll also need to install LaTeX. We recommend [MiKTeX](http://miktex.org/). ## macOS - - You can install pandoc using - [homebrew](http://brew.sh): `brew install pandoc`. - - There is a package installer at pandoc's [download page]. If you later want to uninstall the package, you can do so by downloading [this script][uninstaller] @@ -30,6 +30,12 @@ unzip the file and move the binaries and man pages to whatever directory you like. + - Alternatively, you can install pandoc using + [homebrew](http://brew.sh): `brew install pandoc`. + Note: If you are using macOS < 10.10, this method installs + pandoc from source, so it will take a long time and a lot of + disk space for the ghc compiler and dependent Haskell libraries. + - For PDF output, you'll also need LaTeX. Because a full [MacTeX] installation takes more than a gigabyte of disk space, we recommend installing [BasicTeX](http://www.tug.org/mactex/morepackages.html) @@ -137,13 +143,21 @@ The easiest way to build pandoc from source is to use [stack]: 1. Install the [Haskell platform]. This will give you [GHC] and the [cabal-install] build tool. Note that pandoc requires - GHC >= 7.10. + GHC >= 7.10 and cabal >= 2.0. 2. Update your package database: cabal update -3. Use `cabal` to install pandoc and its dependencies: +3. Check your cabal version with + + cabal --version + + If you have a version less than 2.0, install the latest with: + + cabal install cabal-install + +4. Use `cabal` to install pandoc and its dependencies: cabal install pandoc @@ -156,7 +170,7 @@ The easiest way to build pandoc from source is to use [stack]: cabal install -4. Make sure the `$CABALDIR/bin` directory is in your path. You should +5. Make sure the `$CABALDIR/bin` directory is in your path. You should now be able to run `pandoc`: pandoc --help @@ -200,6 +214,7 @@ over the build and installation. Most users should use the quick install, but this information may be of use to packagers. For more details, see the [Cabal User's Guide]. These instructions assume that the pandoc source directory is your working directory. +You will need cabal version 2.0 or higher. 1. Install dependencies: in addition to the [Haskell platform], you will need a number of additional libraries. You can install @@ -331,5 +346,5 @@ To run just the markdown benchmarks: [openSUSE]: https://software.opensuse.org/package/pandoc [source tarball]: http://hackage.haskell.org/package/pandoc [stack]: http://docs.haskellstack.org/en/stable/install_and_upgrade.html -[cabal-install]: http://hackage.haskell.org/trac/hackage/wiki/CabalInstall +[cabal-install]: http://hackage.haskell.org/package/cabal-install [uninstaller]: https://raw.githubusercontent.com/jgm/pandoc/master/macos/uninstall-pandoc.pl |