Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Caolan McMahon committed Jul 31, 2010
1 parent da38e77 commit 758ebcb
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README
Expand Up @@ -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.

0 comments on commit 758ebcb

Please sign in to comment.