aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index c294c9e..098ad63 100644
--- a/README.md
+++ b/README.md
@@ -48,3 +48,19 @@ Install the drupal instance:
echo '( cd /srv/kvmx && make drush )' | kvmx ssh
echo '( cd /srv/kvmx && make site_install )' | kvmx ssh
+
+### Writing modules
+
+Modules can be written using any programming language. It will be called from the project
+toplevel folder with templater's `share` folder as the first parameter.
+
+Module layout:
+
+- description: states in natural language what the modules does
+- setup: states in programing language what the module does (the actual script)
+- files (optional)
+
+Example: when you call `templater myproject basic`, templater finds a script
+at `$path_to_templater_install/share/basic/setup` and execs it like this:
+
+ cd myproject && share/basic/setup $path_to_templater_install/share/templater