erik/kobalt-doc
erik/kobalt-doc
1
0
Fork 0
mirror of https://github.com/ethauvin/kobalt-doc.git synced 2025-04-25 12:07:10 -07:00
Code Releases Activity

Document new --init

Browse source
This commit is contained in:
Cedric Beust 2017-02-16 15:37:51 -08:00
parent 1d549907f8
commit 484de706c4
1 changed files with 19 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

22
documentation/index.html
View file

@ -388,9 +388,25 @@ dependencies {
<h2 class="section" id="templates">Templates</h2>
<p>
Templates are invoked with the <code>--init</code> parameter and typically used when you are creating
a new project and you want Kobalt to generate a few files to get you started. Plug-ins can provide multiple
templates and you can invoke as many as you need to get your project started. You can get a list of available
templates with the <code>--listTemplates</code> parameter:
a new project and you want Kobalt to generate a few files to get you started. The name that follows
the <code>--init</code> parameter can be of three different types.
<h3 class="section" id="templates-1">A jar/zip file</h3>
<p>
If the file is found and is a zip/jar file, it will be extracted in the current directory.
<pre class="brush:plain">
$ ./kobaltw --init ~/templates/file.jar
</pre>
</p>
<h3 class="section" id="templates-2">A URL pointing to a jar/zip file</h3>
<p>
If the URL is valid and points to a zip/jar file, that file will be extracted in the current directory.
</p>
<pre class="brush:plain">
$ ./kobaltw --init http://example.com/file.jar
</pre>
<h3 class="section" id="templates-3">A template name</h3>
Plug-ins can provide multiple templates and you can invoke as many as you need to get your project started. You can get a list of available templates with the <code>--listTemplates</code> parameter:
</p>
<pre class="brush:plain">
$ kobaltw --listTemplates