Permalink
Browse files

added readme

  • Loading branch information...
alandipert committed Nov 20, 2009
1 parent ab881b3 commit 7ae57a43aa6e41d0641750cf56953fe191f46763
Showing with 21 additions and 0 deletions.
  1. +21 −0 README.markdown
View
@@ -0,0 +1,21 @@
+Interlock Website
+=====
+
+This site was implemented using [nanoc3](http://nanoc.stoneship.org/), a Ruby program that "compiles" templates and content into a static HTML site.
+
+Getting Started
+=======
+
+To compile the site, type:
+
+ rake
+
+This will compile HAML templates into HTML, and copy Javascript, CSS, and images from the `assets` directory to `output`.
+
+Dependencies
+=======
+
+You'll need to have the following gems installed to compile:
+
+* nanoc3
+* haml

0 comments on commit 7ae57a4

Please sign in to comment.