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

Update doc

Browse source
This commit is contained in:
Cedric Beust 2017-03-04 07:53:32 -08:00
parent 484de706c4
commit a22b781730
2 changed files with 18 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

26
getting-started/index.html
View file

@ -40,18 +40,11 @@
<nav id="kobalt-navbar" class="navbar navbar-default">
</nav>
<div class="col-md-9">
<h2 class="section" id="installing">1. Install Kobalt</h2>
<h3 class="section" indent="1" id="homebrew">With HomeBrew</h3>
<p>
If you are on MacOS and have <code>brew</code> installed:
<pre class="brush:plain">
$ brew install kobalt
$ which kobaltw
/usr/local/bin/kobaltw</pre>
</p>
<h2 class="section" id="installing">1. Install Kobalt</h2>
<h3 class="section" indent="1" id="manually">Manually</h3>
<p>
<a href="https://github.com/cbeust/kobalt/releases/latest">Download the zip file</a>, unzip it and add the <code>bin</code> directory to your <code>$PATH</code> variable so that you can invoke the command <code>kobaltw</code>:
<a href="https://github.com/cbeust/kobalt/releases/latest">Download the zip file</a>, unzip it and add the <code>bin</code> directory to your <code>$PATH</code> variable so that you can invoke the command <code>kobaltw</code>:
</p>
<pre class="brush:plain">
cd yourLocation
@ -59,6 +52,19 @@ unzip kobalt-xxx.zip
cd kobalt-xxx
export PATH=$PWD/bin:$PATH
</pre>
<h3 class="section" indent="1" id="homebrew">With HomeBrew</h3>
<p>
If you are on MacOS and have <code>brew</code> installed:
<pre class="brush:plain">
$ brew install kobalt
$ which kobaltw
/usr/local/bin/kobaltw</pre>
</p>
<p>
Note that the Kobalt version on Homebrew might be a bit behind, but once installed, you can easily upgrade to the latest version with <code>kobaltw --update</code>.
</p>
<h2 class="section" id="initialize">2. Initialize your project</h2>
<p>
Change to your project directory and call the <code>kobaltw</code> command with <code>--init</code>:

3
home/index.html
View file

@ -168,7 +168,7 @@ val jcommander = project {
<h2 class="section" id="status">Status</h2>
<p>
Kobalt is currently in Beta but already used in several projects. Here are links to a few build files you can inspect to get a feel for what Kobalt enables:
Here are links to a few build files you can inspect to get a feel for what Kobalt enables:
</p>
<ul>
@ -176,6 +176,7 @@ Kobalt is currently in Beta but already used in several projects. Here are links
<li><a href="https://github.com/cbeust/testng/blob/master/kobalt/src/Build.kt">TestNG</a> (this build file shows an example of adding a custom task in the build itself).</li>
<li><a href="https://github.com/cbeust/klaxon/blob/master/kobalt/src/Build.kt">Klaxon</a></li>
<li><a href="https://github.com/cbeust/kobalt-android">u2020 (Android show case application)</a></li>
<li><a href="https://github.com/cbeust/ktor/blob/kobalt/kobalt/src/Build.kt">Ktor</a></li>
<li>... and of course, <a href="https://github.com/cbeust/kobalt/blob/master/kobalt/src/Build.kt">Kobalt itself</a> (this build file demonstrates multi projects and project dependencies).</li>
</ul>