Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Document in README.md that pandoc must be installed/executable

  • Loading branch information...
commit 8e5b0537094cd35a6636d41b61374f36d16773cd 1 parent 353b1b7
@ocharles ocharles authored
Showing with 16 additions and 5 deletions.
  1. +16 −5 README.md
View
21 README.md
@@ -6,8 +6,19 @@ This is the source code for http://snapframework.com/.
Building
--------
-If you wish to work on the Snap website yourself, you will also need to install
-http://github.com/snapframework/snap-static-pages by hand first. This can be
-done by cloning that repository, and then running `cabal install`. After that,
-you can build a development server by running `cabal configure` and `cabal
-build`.
+If you wish to work on the Snap website yourself, you will also need to perform
+2 extra steps first:
+
+1. Install http://github.com/snapframework/snap-static-pages by hand. This can
+ be done by cloning that repository, and then running `cabal install`.
+
+2. Install pandoc, and make sure the executable is visible to your current
+ `$PATH`. You can do this by running `cabal install pandoc`, and then making
+ sure your `.cabal/bin` directory is in the `$PATH` environment variable. The
+ following is usually enough: `export PATH=~/.cabal/bin:$PATH` and you may
+ wish to perform this automatically on starting your shell (via `.bashrc` or
+ otherwise) if you haven't already.
+
+After that, you can build a development server by running `cabal configure` and
+`cabal build`.
+
Please sign in to comment.
Something went wrong with that request. Please try again.