Commit fcf6b156 authored by Steve Losh's avatar Steve Losh
Browse files

Add a simple README.

parent 3efd1dcf92c7
-*- 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
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment