annotate 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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
253
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
1 -*- markdown -*-
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
2
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
3 hg-website
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
4 ==========
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
5
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
6 This is a fork of the original hg-scm.org website. It has two goals:
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
7
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
8 * 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.
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
9 * Move all the content into a subrepository so volunteers can just clone that repository if they just want to edit the content.
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
10
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
11 Setup
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
12 -----
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
13
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
14 To use this version of hg-website you need to install a few things:
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
15
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
16 Blatter's prerequisites:
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
17
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
18 easy_install jinja2
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
19 easy_install werkzeug
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
20
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
21 My patched version of blatter (adds the ability to ignore files and add custom Jinja2 filters):
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
22
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
23 hg clone http://bitbucket.org/sjl/blatter/
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
24 cd blatter
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
25 python setup.py install
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
26
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
27 Usage
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
28 -----
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
29
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
30 To have blatter serve the page dynamically, use:
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
31
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
32 blatter serve
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
33
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
34 You can then visit [http://localhost:8008](http://localhost:8008) to view the site.
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
35
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
36 To render a static version of the site into the `out/` directory:
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
37
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
38 blatter blat
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
39
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
40 For more information on using blatter, check the README file at [http://bitbucket.org/sjl/blatter/src/](http://bitbucket.org/sjl/blatter/src/)