Mercurial > hg-website
diff README @ 253:fcf6b1564285
Add a simple README.
author | Steve Losh <steve@stevelosh.com> |
---|---|
date | Thu, 24 Sep 2009 17:59:16 -0400 |
parents | |
children | d662cba2afb1 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README Thu Sep 24 17:59:16 2009 -0400 @@ -0,0 +1,40 @@ +-*- markdown -*- + +hg-website +========== + +This is a fork of the original hg-scm.org website. It has two goals: + +* Instead of using Django to serve the site, use Blatter to generate a static version which can then be served by a normal webserver like Apache or nginx. +* Move all the content into a subrepository so volunteers can just clone that repository if they just want to edit the content. + +Setup +----- + +To use this version of hg-website you need to install a few things: + +Blatter's prerequisites: + + easy_install jinja2 + easy_install werkzeug + +My patched version of blatter (adds the ability to ignore files and add custom Jinja2 filters): + + hg clone http://bitbucket.org/sjl/blatter/ + cd blatter + python setup.py install + +Usage +----- + +To have blatter serve the page dynamically, use: + + blatter serve + +You can then visit [http://localhost:8008](http://localhost:8008) to view the site. + +To render a static version of the site into the `out/` directory: + + blatter blat + +For more information on using blatter, check the README file at [http://bitbucket.org/sjl/blatter/src/](http://bitbucket.org/sjl/blatter/src/) \ No newline at end of file