diff options
| author | Silvio Rhatto <rhatto@riseup.net> | 2017-10-31 17:23:15 -0200 |
|---|---|---|
| committer | Silvio Rhatto <rhatto@riseup.net> | 2017-10-31 17:23:15 -0200 |
| commit | 82e6bce4ea8fc61e99f6eb32dc12c470b93dccd4 (patch) | |
| tree | 4b81210f80e8a3e85a1d65b01beb67f92a727066 /README.md | |
| parent | 8e83eb20f8841022cf9a221f2e8447cdba1f7270 (diff) | |
| download | templater-82e6bce4ea8fc61e99f6eb32dc12c470b93dccd4.tar.gz templater-82e6bce4ea8fc61e99f6eb32dc12c470b93dccd4.tar.bz2 | |
New module format
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 16 insertions, 0 deletions
@@ -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 |