From 758ebcb4c09f80d754bbf982bf662739c8784c86 Mon Sep 17 00:00:00 2001 From: Caolan McMahon Date: Sat, 31 Jul 2010 16:36:03 +0100 Subject: [PATCH] updated README --- README | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README b/README index 927e2e6..7c9c192 100644 --- a/README +++ b/README @@ -39,3 +39,16 @@ _A simple and flexible static site generator_ emails. This works well if you host projects on GitHub, which is already very markdown friendly. You can run a Petrify site generator on the doc directory of your project and have pretty HTML docs for your own domain. + +## Getting started + +First, install the latest version of [node.js](http://nodejs.org/#download). +Petrify uses git submodules for the rest of its dependencies. Once you've +cloned the repository, do: + + git submodule update --init --recursive + +Then, cd to the examples directory and run the build script. This will create +a www directory with a bunch of HTML files inside. Voila! you've just generated +your first site. For now, the example site and the files in the doc directory +will have to be enough to get you started.