changeset 92:bfab7367eb56

add some more documentation tidbits
author Jeff Hammel <jhammel@mozilla.com>
date Mon, 10 Jan 2011 21:49:43 -0800
parents 672d2d3ee322
children d5da38fabdf7
files README.txt
diffstat 1 files changed, 30 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/README.txt	Mon Jan 10 21:42:32 2011 -0800
+++ b/README.txt	Mon Jan 10 21:49:43 2011 -0800
@@ -14,6 +14,11 @@
 cares?  But quickly one-offs become a deployment story, and not a very
 efficient one.  
 
+
+Making a New Template
+---------------------
+
+
 Variable Conventions
 --------------------
 
@@ -27,3 +32,28 @@
 conventions, a neighboring file may be (e.g.) included like
 
 {{include(here + 'foo.txt')}}
+
+The python template asserts several conventions:
+
+- project: the project chosen
+- author: author of a project
+- email: author's email
+- url: url of the project
+
+
+Adding a License to a Template
+------------------------------
+
+[TODO]
+
+
+Web Service
+-----------
+
+python has the ability to run files from stdin.  This means you can
+run makeitso directly from the web::
+
+ python <(curl http://k0s.org/mozilla/hg/MakeItSo/raw-file/tip/makeitso/makeitso.py) [URI] 
+
+This uses the bash shell.  If you have another shell you may have to
+use another syntax, download the file, or install the package.