From 5322edf771d426f4af4cf3aae6eaf93de97e8364 Mon Sep 17 00:00:00 2001 From: Andrew Kesterson Date: Sun, 5 Aug 2012 22:29:31 -0400 Subject: [PATCH] more readme --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 918c373..f4f925f 100644 --- a/README.md +++ b/README.md @@ -150,7 +150,9 @@ are enabled). Templates have access to all client parameters via the disco-param Definition Files ===== -Definition files are just a series of files that say where to rsync files, templates, and scripts from. +Definition files are just a series of files that say what files on the disk should be templated, +or executed as scripts, for this module; as well as defining module-level parameters, and dependency +requirements, for this module. Definition files can use node parameters via the $(disco-param /path/to/node/parameter) syntax. This interpolation is done on the client side, so the server does not execute any code for this. @@ -165,7 +167,6 @@ A disco module (also called a "disco ball" for fun) looks like this: MODULE ├__ defs ___ ___ requires - │__ ├── files │__ ├── scripts │__ └── templates ___ ___ parameters @@ -179,6 +180,8 @@ to your module, inside its disco ball. The disco ball is then placed in an acces on the rsync server, and the disco client will pull all modules, files, scripts, and templates relevant to its execution, and run them. +ALL MODULE FILES, SCRIPTS, AND TEMPLATES ARE DELIVERED RELATIVE TO / ON THE CLIENT. + MODULE/defs/requires =====