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

Update "Contributing" section.

Browse source
This commit is contained in:
Cedric Beust 2016-01-27 15:26:26 -08:00
parent bb27130d07
commit 174a59eadd
1 changed files with 28 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

31
contributing/index.html
View file

@ -37,7 +37,7 @@
<!-- Main component for a primary marketing message or call to action -->
<!-- Main content -->
<div class="col-md-9">
<h2 class="section" id="launch_configuration">License, Source code & Issues</h2>
<h2 class="section" id="license">License, Source code & Issues</h2>
<p>
Kobalt is <a href="https://github.com/cbeust/kobalt/blob/master/LICENSE.txt">licensed under Apache 2.0</a>
</p>
@ -53,8 +53,33 @@
<li><a href="https://groups.google.com/forum/#!forum/kobalt-dev">Join <code>kobalt-dev</code>, the mailing-list for Kobalt developers</a>. This mailing-list is for people interested in writing code for Kobalt, either the core, or writing plug-ins, or just to follow various technical discussions about Kobalt's internals.</li>
</ul>
<h2 class="section" id="launch_configuration">Launch configuration</h2>
<p>Here is how to configure your development environment.</p>
<h2 class="section" id="idea">Configuring IDEA</h2>
<p>
Working on the Kobalt code base with Intellij IDEA is very easy.
</p>
<h3 class="section" id="version" indent="1">Edit kobalt.version</h3>
<p>
First of all, edit the file <code>src/main/resources/kobalt.properties</code> and set it
to a nonexistent version. For example, if the current version is <code>0.399</code>,
set it to <code>0.400</code>.
</p>
<pre class="brush:plain">
kobalt.version=0.400
</pre>
<p>
When you launch Kobalt from IDEA with a nonexistent version, Kobalt will show a message saying
that it couldn't locate that version and instead, it will use the classes generated by IDEA. This
way, you will always be running the files that you just modified with IDEA. On start up,
Kobalt will display a message looking like:
</p>
<pre class="brush:plain">
Couldn't find .../kobalt-0.400.jar, using ...
</pre>
<p>
Note that at the moment, Kobalt expects to be located in <code>$HOME/kotlin/kobalt</code>.
</p>
<h3 class="section" id="launch_configuration" indent="1">Launch configuration</h3>
<p>Next, create a launch configuration in IDEA.</p>
<p>
Kobalt's main class is <code>com.beust.kobalt.MainKt</code>. Here is a typical launch configuration:
</p>