annotate README @ 412:9681da59a95b

Wrap lines
author Martin Geisler <martin@geisler.net>
date Fri, 29 Aug 2014 12:25:04 +0200
parents 640c68441419
children
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
412
9681da59a95b Wrap lines
Martin Geisler <martin@geisler.net>
parents: 411
diff changeset
6 This is the Mercurial website. It uses the microframework flask to
9681da59a95b Wrap lines
Martin Geisler <martin@geisler.net>
parents: 411
diff changeset
7 serve jinja2 templates.
346
dfc40e532bb6 Add a section about various subrepos of hg-website
David Soria Parra <dsp@php.net>
parents: 254
diff changeset
8
253
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
9 Setup
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
397
29d4b5e45423 Use flask to render site and get rid of submodules
David Soria Parra <davidsp@fb.com>
parents: 346
diff changeset
12 To use this version of hg-website you need to install flask.
253
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
13
410
c838aca30aea Fix typo in pip install command
Martin Geisler <martin@geisler.net>
parents: 397
diff changeset
14 pip install flask
254
d662cba2afb1 Add markdown to the README.
Steve Losh <steve@stevelosh.com>
parents: 253
diff changeset
15
253
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
16 Usage
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
397
29d4b5e45423 Use flask to render site and get rid of submodules
David Soria Parra <davidsp@fb.com>
parents: 346
diff changeset
19 To have flask serve the page, use:
253
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
20
411
640c68441419 Fix command to start Flask
Martin Geisler <martin@geisler.net>
parents: 410
diff changeset
21 python hgwebsite.py
253
fcf6b1564285 Add a simple README.
Steve Losh <steve@stevelosh.com>
parents:
diff changeset
22
412
9681da59a95b Wrap lines
Martin Geisler <martin@geisler.net>
parents: 411
diff changeset
23 You can then visit [http://localhost:5000](http://localhost:5000) to
9681da59a95b Wrap lines
Martin Geisler <martin@geisler.net>
parents: 411
diff changeset
24 view the site.