Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Add documentation on how to build to README.md #20

Merged
merged 2 commits into from

2 participants

Oliver Charles Doug Beardsley
Oliver Charles

As the steps to build this are not entirely straight forward, I felt they should be documented.

Doug Beardsley mightybyte merged commit e3fedff into from
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
This page is out of date. Refresh to see the latest.
Showing with 20 additions and 0 deletions.
  1. +20 −0 README.md
20 README.md
View
@@ -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`.
+
Something went wrong with that request. Please try again.