mirror of
https://github.com/ethauvin/kobalt-doc.git
synced 2025-04-25 03:57:11 -07:00
move github link to contributing page
This commit is contained in:
Juan Liska
parent
6112dda189
commit
dd21509bd0
5 changed files with 102 additions and 136 deletions
|
|
@ -1,107 +1,95 @@
|
|||
<html>
|
||||
<head>
|
||||
<title>
|
||||
<head>
|
||||
<title>
|
||||
Kobalt, by Cedric Beust
|
||||
</title>
|
||||
<!-- Bootstrap core CSS -->
|
||||
<script type="text/javascript" src="../sh/scripts/shCore.js"></script>
|
||||
<script type="text/javascript" src="../sh/scripts/shBrushJScript.js"></script>
|
||||
<script type="text/javascript" src="../sh/scripts/shBrushJava.js"></script>
|
||||
<script type="text/javascript" src="../sh/scripts/shBrushPlain.js"></script>
|
||||
<script>
|
||||
SyntaxHighlighter.defaults['gutter'] = false;
|
||||
SyntaxHighlighter.defaults['toolbar'] = false;
|
||||
SyntaxHighlighter.all();
|
||||
</script>
|
||||
<!-- Optional Bootstrap Theme -->
|
||||
<link href="data:text/css;charset=utf-8," data-href="../bootstrap/dist/css/bootstrap-theme.min.css" rel="stylesheet" id="bs-theme-stylesheet">
|
||||
<!--[if lt IE 9]><script src="../assets/js/ie8-responsive-file-warning.js"></script><![endif]-->
|
||||
<!--
|
||||
<script src="../bootstrap/assets/js/ie-emulation-modes-warning.js"></script>
|
||||
-->
|
||||
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
|
||||
<!--[if lt IE 9]>
|
||||
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
|
||||
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
||||
<![endif]-->
|
||||
<!-- Favicons -->
|
||||
<!--
|
||||
<link rel="icon" href="/favicon.ico">
|
||||
-->
|
||||
</head>
|
||||
<body>
|
||||
<div class="container">
|
||||
<!-- Static navbar -->
|
||||
<nav id="kobalt-navbar" class="navbar navbar-default">
|
||||
</nav>
|
||||
<!-- Main component for a primary marketing message or call to action -->
|
||||
<div class="jumbotron">
|
||||
<h1>Contributing to Kobalt</h1>
|
||||
</div>
|
||||
<!-- Main content -->
|
||||
<div class="col-md-9">
|
||||
<h2 class="section" id="launch_configuration">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>
|
||||
<p>
|
||||
You can contribute code and report issues at the <a href="https://github.com/cbeust/kobalt">Kobalt Github Repo</a>
|
||||
</p>
|
||||
|
||||
Kobalt, by Cedric Beust
|
||||
<h2 class="section" id="discuss">Discuss Kobalt</h2>
|
||||
<ul>
|
||||
<li>Live discussions are happening on Kotlin's Slack Channel, managed by JetBrains. You can get an automated invitation <a href="http://kotlinslackin.herokuapp.com/">here</a> and then, just join the <code>#kobalt</code> channel.
|
||||
</li>
|
||||
<li><a href="https://groups.google.com/forum/#!forum/kobalt-users">Join <code>kobalt-users</code>, the mailing-list for Kobalt users.</a></li>
|
||||
<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>
|
||||
|
||||
</title>
|
||||
|
||||
<!-- Bootstrap core CSS -->
|
||||
|
||||
<script type="text/javascript" src="../sh/scripts/shCore.js"></script>
|
||||
<script type="text/javascript" src="../sh/scripts/shBrushJScript.js"></script>
|
||||
<script type="text/javascript" src="../sh/scripts/shBrushJava.js"></script>
|
||||
<script type="text/javascript" src="../sh/scripts/shBrushPlain.js"></script>
|
||||
|
||||
<script>
|
||||
SyntaxHighlighter.defaults['gutter'] = false;
|
||||
SyntaxHighlighter.defaults['toolbar'] = false;
|
||||
SyntaxHighlighter.all();
|
||||
</script>
|
||||
|
||||
|
||||
<!-- Optional Bootstrap Theme -->
|
||||
|
||||
<link href="data:text/css;charset=utf-8," data-href="../bootstrap/dist/css/bootstrap-theme.min.css" rel="stylesheet" id="bs-theme-stylesheet">
|
||||
|
||||
|
||||
<!--[if lt IE 9]><script src="../assets/js/ie8-responsive-file-warning.js"></script><![endif]-->
|
||||
<!--
|
||||
<script src="../bootstrap/assets/js/ie-emulation-modes-warning.js"></script>
|
||||
-->
|
||||
|
||||
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
|
||||
<!--[if lt IE 9]>
|
||||
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
|
||||
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<!-- Favicons -->
|
||||
<!--
|
||||
<link rel="icon" href="/favicon.ico">
|
||||
-->
|
||||
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
|
||||
<div class="container">
|
||||
|
||||
<!-- Static navbar -->
|
||||
<nav id="kobalt-navbar" class="navbar navbar-default">
|
||||
</nav>
|
||||
|
||||
<!-- Main component for a primary marketing message or call to action -->
|
||||
<div class="jumbotron">
|
||||
<h1>Contributing to Kobalt</h1>
|
||||
<p>Interested in contributing to Kobalt? This page explains how to configure your development environment.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<!-- Main content -->
|
||||
<div class="col-md-9">
|
||||
|
||||
<h2 class="section" id="launch_configuration">Launch configuration</h2>
|
||||
|
||||
<p>
|
||||
Kobalt's main class is <code>com.beust.kobalt.MainKt</code>. Here is a typical launch configuration:
|
||||
</p>
|
||||
<p align="center">
|
||||
<img width="99%" class="img-rounded" src="../pics/launch-configuration.png"/>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
A few observations:
|
||||
<ul>
|
||||
<li>You can ask Kobalt to build external projects by specifying a non-empty "Working Directory".</li>
|
||||
<li>The default log level is 1. 2 is useful for debugging and 3 will be extremely verbose.</li>
|
||||
<li>Another command line parameter worth of notice is <code>--dev</code>, which will add the class
|
||||
<h2 class="section" id="launch_configuration">Launch configuration</h2>
|
||||
<p>Here is how to configure your development environment.</p>
|
||||
<p>
|
||||
Kobalt's main class is <code>com.beust.kobalt.MainKt</code>. Here is a typical launch configuration:
|
||||
</p>
|
||||
<p align="center">
|
||||
<img width="99%" class="img-rounded" src="../pics/launch-configuration.png"/>
|
||||
</p>
|
||||
<p>
|
||||
A few observations:
|
||||
<ul>
|
||||
<li>You can ask Kobalt to build external projects by specifying a non-empty "Working Directory".</li>
|
||||
<li>The default log level is 1. 2 is useful for debugging and 3 will be extremely verbose.</li>
|
||||
<li>Another command line parameter worth of notice is <code>--dev</code>, which will add the class
|
||||
name and thread information to each log line.</li>
|
||||
<li>Checking the "Single instance" box is useful to avoid duplicating these launch configurations.</li>
|
||||
</ul>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<!-- Table of contents -->
|
||||
<div class="col-md-3" id="table-of-contents">
|
||||
</div>
|
||||
|
||||
<!-- Bootstrap core JavaScript
|
||||
================================================== -->
|
||||
<!-- Placed at the end of the document so the pages load faster -->
|
||||
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
|
||||
<script src="../bootstrap/dist/js/bootstrap.min.js"></script>
|
||||
<script src="../js/kobalt.js"></script>
|
||||
<script>generateKobalt(6);</script>
|
||||
|
||||
<!--
|
||||
<script src="../../assets/js/docs.min.js"></script>
|
||||
-->
|
||||
<!-- IE10 viewport hack for Surface/desktop Windows 8 bug -->
|
||||
<!--
|
||||
<script src="../../assets/js/ie10-viewport-bug-workaround.js"></script>
|
||||
-->
|
||||
|
||||
</body>
|
||||
<li>Checking the "Single instance" box is useful to avoid duplicating these launch configurations.</li>
|
||||
</ul>
|
||||
</p>
|
||||
</div>
|
||||
<!-- Table of contents -->
|
||||
<div class="col-md-3" id="table-of-contents">
|
||||
</div>
|
||||
<!-- Bootstrap core JavaScript
|
||||
================================================== -->
|
||||
<!-- Placed at the end of the document so the pages load faster -->
|
||||
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
|
||||
<script src="../bootstrap/dist/js/bootstrap.min.js"></script>
|
||||
<script src="../js/kobalt.js"></script>
|
||||
<script>generateKobalt(6);</script>
|
||||
<!--
|
||||
<script src="../../assets/js/docs.min.js"></script>
|
||||
-->
|
||||
<!-- IE10 viewport hack for Surface/desktop Windows 8 bug -->
|
||||
<!--
|
||||
<script src="../../assets/js/ie10-viewport-bug-workaround.js"></script>
|
||||
-->
|
||||
</body>
|
||||
|
|
@ -2,6 +2,10 @@
|
|||
* Kobalt CSS
|
||||
*/
|
||||
|
||||
.features {
|
||||
font-size: 1.5em;
|
||||
}
|
||||
|
||||
code {
|
||||
background-color: #ffffff;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -548,29 +548,6 @@ dependencies {
|
|||
"com.squareup.okhttp:okhttp:2.5.0",
|
||||
</pre>
|
||||
|
||||
<h2 class="section" id="sources">Sources and license</h2>
|
||||
|
||||
<p>
|
||||
Kobalt is <a href="https://github.com/cbeust/kobalt/blob/master/LICENSE.txt">licensed under Apache 2.0</a> and is <a href="http://github.com/cbeust/kobalt">currently hosted on github.</a>
|
||||
</p>
|
||||
|
||||
<h2 class="section" id="discuss">Discuss Kobalt</h2>
|
||||
|
||||
<p>
|
||||
If you are interested in discussing Kobalt related topics with other fellow users or developers, you have several options:
|
||||
</p>
|
||||
|
||||
<ul>
|
||||
<li>Live discussions are happening on Kotlin's Slack Channel, managed by JetBrains. You can get an automated invitation <a href="http://kotlinslackin.herokuapp.com/">here</a> and then, just join the <code>#kobalt</code> channel.
|
||||
</li>
|
||||
<li><a href="https://groups.google.com/forum/#!forum/kobalt-users">Join <code>kobalt-users</code>, the mailing-list for Kobalt users.</a></li>
|
||||
<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>
|
||||
|
||||
<p>
|
||||
</p>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -57,9 +57,6 @@
|
|||
|
||||
<!-- Main component for a primary marketing message or call to action -->
|
||||
<div class="jumbotron">
|
||||
<h1>Kobalt</h1>
|
||||
<p>A universal build system for the exigent developer.</p>
|
||||
<img src="../pics/auto-completion.png" class="img-rounded"/>
|
||||
|
||||
<!--
|
||||
<p>
|
||||
|
|
|
|||
|
|
@ -56,18 +56,18 @@
|
|||
<!-- Main component for a primary marketing message or call to action -->
|
||||
<div class="jumbotron">
|
||||
<h1>Kobalt: friendly, fast build system</h1>
|
||||
<img src="../pics/auto-completion.png" class="img-rounded"/>
|
||||
</div>
|
||||
|
||||
<!-- Main content -->
|
||||
<div class="col-md-9">
|
||||
<img src="../pics/auto-completion.png" class="img-rounded"/>
|
||||
|
||||
<h2 class="section" id="overview">Features</h2>
|
||||
<ul>
|
||||
<li><h4>Intuitive DSL and plug-in architecture</h4></li>
|
||||
<li><h4>Fast builds</h4></li>
|
||||
<li><h4>Build file auto-completion from your favorite IDE</h4></li>
|
||||
<li><h4>A cleaner syntax than Ant, Maven, Gradle, or SBT</h4></li>
|
||||
<ul class="features">
|
||||
<li>Clean, easy-to-use syntax for build files</li>
|
||||
<li>Build file auto-completion from your favorite IDE</li>
|
||||
<li>Intuitive plug-in architecture</li>
|
||||
<li>Fast builds</li>
|
||||
</ul>
|
||||
</p>
|
||||
|
||||
|
|
@ -116,7 +116,7 @@ val jcommander = javaProject {
|
|||
<li>An agnostic build tool. Kobalt can be used to build Kotlin and Java projects today but it's capable to build anything: any language (JVM or not) or platform (Android, Spring, ...).
|
||||
</ul>
|
||||
|
||||
<h2 id="path">The path to Kobalt 1.0</h2>
|
||||
<h2 class="section" id="path">Status</h2>
|
||||
|
||||
<p>
|
||||
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:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue