From 21cc6f015d138971004cb36e892d1473fc38b3c9 Mon Sep 17 00:00:00 2001 From: Egor Tolstoy Date: Wed, 16 Nov 2016 13:56:04 +0300 Subject: [PATCH] Update roadmap.md --- docs/2.x/roadmap.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/2.x/roadmap.md b/docs/2.x/roadmap.md index e162cfa..a2fd2d6 100644 --- a/docs/2.x/roadmap.md +++ b/docs/2.x/roadmap.md @@ -222,10 +222,22 @@ Templates and tempalte catalogs, used for code generation, can be specified righ ``` ramba :viper_module do - + catalog 'https://github.com/user/catalog', branch:'develop' + template 'viper_ios', version:'1.2.5' + template 'viper_ios2', path:'/local_templates' end ``` +- `catalog` keyword specifies a custom template catalog (like https://github.com/rambler-digital-solutions/generamba-catalog). + - `branch` parameter specifies a concrete catalog branch +- `template` keyword declares a template that needs to be installed + - `version` parameter specifies a concrete template version. + - `path` parameter specifies a local path to the template. + - `git` parameter specifies a remote repository path to a template. + - `branch` parameter is used together with `git` to specify a branch. + +The `generamba template install` command aggregates all of the templates from the `Rambafile` and installs them in a `.generamba` hidden directory. When a user triggers some `ramba`, templates are loaded from this directory. The only exception are local templates - they are always installed from the specified in the `Rambafile` local path. + ### Plugins The main ideas behind plugin system are: