diff --git a/contributing/index.html b/contributing/index.html new file mode 100644 index 0000000..0fef1f3 --- /dev/null +++ b/contributing/index.html @@ -0,0 +1,141 @@ + + + + + Kobalt, by Cedric Beust + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+

Contributing to Kobalt

+

Interested in contributing to Kobalt? This page explains how to configure your development environment.

+ +
+ + +
+ +

Launch configuration

+ +

+ Kobalt's main class is `com.beust.kobalt.MainKt`. Here is a typical launch configuration: +

+

+ +

+ +

+ A few observations: +

+ +

+ +

Auto complete in build files

+

+ It's useful to turn on auto completion for your Build.kt file if you are adding new + elements to the DSL. You can achieve this in two steps. +

+ +

Sync your build file

+

+ This is achieved with the Kobalt / Sync build file menu item. On top of configuring your + IDEA project with the correct dependencies, this will also add the kobalt.jar file to your + classpath. +

+

+ +

+

+ +

+ + +

Compile your build file

+

+ Next, mark the directory that contains your build file as a "Source directory": +

+

+ +

+
+

Alternate source directory for Build.kt

+ The default location for Build.kt is in the root directory of your project but + you can also put it in kobalt/src/Build.kt and then mark that directory as + a source directory. +
+ +

+ You can now use all the IDEA features on your build file: +

+

+ +

+ +
+ + +
+
+ + + + + + + + + + + + + diff --git a/js/kobalt.js b/js/kobalt.js index e6b6c95..1e4919f 100644 --- a/js/kobalt.js +++ b/js/kobalt.js @@ -28,6 +28,10 @@ var content = [ { url: "../ten-minutes/index.html", title: "Ten minutes" + }, + { + url: "../contributing/index.html", + title: "Contributing" } ]; diff --git a/pics/auto-complete.png b/pics/auto-complete.png new file mode 100644 index 0000000..566ea55 Binary files /dev/null and b/pics/auto-complete.png differ diff --git a/pics/kobalt-jar.png b/pics/kobalt-jar.png new file mode 100644 index 0000000..41e15b8 Binary files /dev/null and b/pics/kobalt-jar.png differ diff --git a/pics/launch-configuration.png b/pics/launch-configuration.png new file mode 100644 index 0000000..a30a495 Binary files /dev/null and b/pics/launch-configuration.png differ diff --git a/pics/menu-sync.png b/pics/menu-sync.png new file mode 100644 index 0000000..e40707f Binary files /dev/null and b/pics/menu-sync.png differ diff --git a/pics/source-root.png b/pics/source-root.png new file mode 100644 index 0000000..a7c7c18 Binary files /dev/null and b/pics/source-root.png differ