Mercurial > hg > MakeItSo

comparison README.txt @ 92:bfab7367eb56

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add some more documentation tidbits
author Jeff Hammel <jhammel@mozilla.com>
date Mon, 10 Jan 2011 21:49:43 -0800
parents 672d2d3ee322
children 3eb34cad5858
comparison
equal deleted inserted replaced
91:672d2d3ee322 92:bfab7367eb56
12 12
13 And this is the time of the iceberg. If it really is a one-off, who 13 And this is the time of the iceberg. If it really is a one-off, who
14 cares? But quickly one-offs become a deployment story, and not a very 14 cares? But quickly one-offs become a deployment story, and not a very
15 efficient one. 15 efficient one.
16 16
17
18 Making a New Template
19 ---------------------
20
21
17 Variable Conventions 22 Variable Conventions
18 -------------------- 23 --------------------
19 24
20 MakeItSo! provides a few variables for you. You can include another 25 MakeItSo! provides a few variables for you. You can include another
21 file or URL using {{include(URI)}}, where URI is the file path or the 26 file or URL using {{include(URI)}}, where URI is the file path or the
25 Files and URLS being interpolated also have the variable %(here)s, 30 Files and URLS being interpolated also have the variable %(here)s,
26 which is the parent of their resource. Therefor, using sensible path 31 which is the parent of their resource. Therefor, using sensible path
27 conventions, a neighboring file may be (e.g.) included like 32 conventions, a neighboring file may be (e.g.) included like
28 33
29 {{include(here + 'foo.txt')}} 34 {{include(here + 'foo.txt')}}
35
36 The python template asserts several conventions:
37
38 - project: the project chosen
39 - author: author of a project
40 - email: author's email
41 - url: url of the project
42
43
44 Adding a License to a Template
45 ------------------------------
46
47 [TODO]
48
49
50 Web Service
51 -----------
52
53 python has the ability to run files from stdin. This means you can
54 run makeitso directly from the web::
55
56 python <(curl http://k0s.org/mozilla/hg/MakeItSo/raw-file/tip/makeitso/makeitso.py) [URI]
57
58 This uses the bash shell. If you have another shell you may have to
59 use another syntax, download the file, or install the package.