From abbf4ade79f4f9bdbd2806c2797201c65ca82a31 Mon Sep 17 00:00:00 2001 From: Cedric Beust Date: Thu, 14 Jan 2016 21:17:32 -0800 Subject: [PATCH] Doc fixes. --- getting-started/index.html | 27 ++++++++++++++++++--------- home/index.html | 10 +++++++++- 2 files changed, 27 insertions(+), 10 deletions(-) diff --git a/getting-started/index.html b/getting-started/index.html index 3f11beb..070cf21 100644 --- a/getting-started/index.html +++ b/getting-started/index.html @@ -48,7 +48,11 @@ cd $KOBALT_HOME unzip kobalt-xxx.zip -

2. Initialize your project for Kobalt

+

+ Note: Kobalt doesn't need any environment variable to run, the environment variable used above + is only here for clarity. +

+

2. Initialize your project

Change to your project directory and call the kobaltw command with --init:

@@ -60,8 +64,8 @@ $KOBALT_HOME/kobaltw --init This command will do two things:

    -
  1. Create a default kobalt/src/Build.kt file based on what was found there. -
  2. Install the Kobalt Wrapper in your current directory (script `kobaltw`) and in the kobalt/ directory. From now on, you can just use ./kobaltw to build and you can ignore $KOBALT_HOME. +
  3. Create a default kobalt/src/Build.kt file based on what was found in your project. +
  4. Install the Kobalt Wrapper in your current directory (a script called kobaltw) and a few additional files in the kobalt/wrapper directory. From now on, you can just use ./kobaltw to build and you can ignore $KOBALT_HOME.

You can now attempt to build your project with Kobalt: @@ -74,7 +78,7 @@ $KOBALT_HOME/kobaltw --init

3. Edit kobalt/src/Build.kt

- Here for example is the Build.kt for wasabi http framework + Here is the Build.kt for the Wasabi HTTP framework: 
 import com.beust.kobalt.*
 import com.beust.kobalt.plugin.packaging.assemble
@@ -89,7 +93,7 @@ val p = kotlinProject {
     artifactId = name
     version = "0.1"
 
-    //tells Kobalt to also search here for dependencies
+    // Tell Kobalt to also search here for dependencies
     val repos = repos("http://oss.sonatype.org/content/repositories/snapshots") 
 
     dependencies {
@@ -110,7 +114,7 @@ val p = kotlinProject {
             "joda-time:joda-time:2.3")
     }
 
-    //these are only downloaded when running the test task
+    // Test dependencies
     dependenciesTest {
         compile("junit:junit:4.9",
             "org.mockito:mockito-all:1.9.5",
@@ -118,7 +122,7 @@ val p = kotlinProject {
             "org.apache.httpcomponents:httpclient:4.5.1")
     }
 
-    //tells kobalt to produce a jar
+    // Tell kobalt to produce a jar
     assemble {
         jar {
         }
@@ -126,12 +130,17 @@ val p = kotlinProject {
 }
-

4. In Intellij IDEA, Sync Build File

+

4. Sync your build file

If you're using Intellij IDEA, make sure you've installed the Kobalt plugin and then go to Kobalt -> Sync Build File. This will download dependencies in a way that IDEA understand so you no loger get errors.

- +

5. Next steps

+

+ From this point, you can either learn how to install the Kobalt IDEA plug-in or read Kobalt's documentation. +

+ +
diff --git a/home/index.html b/home/index.html index 9a34619..eef955f 100644 --- a/home/index.html +++ b/home/index.html @@ -75,6 +75,8 @@ Here are some of Kobalt's most prominent features.

+

Features

+

Build file auto-completion in your IDE

Since Kobalt's build files are actual Kotlin files, not only can you leverage auto-completion @@ -163,7 +165,7 @@ val jcommander = javaProject {

Status

-Kobalt is currently in Beta but I'm already using it to build most of my projects. Here are links to a few build files you can inspect to get a feel for what Kobalt enables: +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:

+

Next steps

+ Proceed to the Getting Started section to learn more about Kobalt. +

+ + +