Permalink
Browse files

Merge pull request #20 from ocharles/readme-build-instructions

Add documentation on how to build to README.md
  • Loading branch information...
2 parents b793520 + 8e5b053 commit e3fedffa9c9d7dcb18f2257e05054b8b76b35eb2 @mightybyte mightybyte committed Sep 19, 2012
Showing with 20 additions and 0 deletions.
  1. +20 −0 README.md
View
20 README.md
@@ -2,3 +2,23 @@ Snap Website
------------
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 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`.
+

0 comments on commit e3fedff

Please sign in to comment.