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

move github link to contributing page

Browse source
This commit is contained in:
Juan Liska 2016-01-05 05:44:04 -06:00
parent 6112dda189
commit dd21509bd0
5 changed files with 102 additions and 136 deletions
Download patch file Download diff file Expand all files Collapse all files

44
contributing/index.html
View file

@ -1,76 +1,69 @@
<html> <html>
<head> <head>
<title> <title>
Kobalt, by Cedric Beust Kobalt, by Cedric Beust
</title> </title>
<!-- Bootstrap core CSS --> <!-- Bootstrap core CSS -->
<script type="text/javascript" src="../sh/scripts/shCore.js"></script> <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/shBrushJScript.js"></script>
<script type="text/javascript" src="../sh/scripts/shBrushJava.js"></script> <script type="text/javascript" src="../sh/scripts/shBrushJava.js"></script>
<script type="text/javascript" src="../sh/scripts/shBrushPlain.js"></script> <script type="text/javascript" src="../sh/scripts/shBrushPlain.js"></script>
<script> <script>
SyntaxHighlighter.defaults['gutter'] = false; SyntaxHighlighter.defaults['gutter'] = false;
SyntaxHighlighter.defaults['toolbar'] = false; SyntaxHighlighter.defaults['toolbar'] = false;
SyntaxHighlighter.all(); SyntaxHighlighter.all();
</script> </script>
<!-- Optional Bootstrap Theme --> <!-- 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"> <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]--> <!--[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> <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 --> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script> <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> <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]--> <![endif]-->
<!-- Favicons --> <!-- Favicons -->
<!-- <!--
<link rel="icon" href="/favicon.ico"> <link rel="icon" href="/favicon.ico">
--> -->
</head> </head>
<body> <body>
<div class="container"> <div class="container">
<!-- Static navbar --> <!-- Static navbar -->
<nav id="kobalt-navbar" class="navbar navbar-default"> <nav id="kobalt-navbar" class="navbar navbar-default">
</nav> </nav>
<!-- Main component for a primary marketing message or call to action --> <!-- Main component for a primary marketing message or call to action -->
<div class="jumbotron"> <div class="jumbotron">
<h1>Contributing to Kobalt</h1> <h1>Contributing to Kobalt</h1>
<p>Interested in contributing to Kobalt? This page explains how to configure your development environment.</p>
</div> </div>
<!-- Main content --> <!-- Main content -->
<div class="col-md-9"> <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>
<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>
<h2 class="section" id="launch_configuration">Launch configuration</h2> <h2 class="section" id="launch_configuration">Launch configuration</h2>
<p>Here is how to configure your development environment.</p>
<p> <p>
Kobalt's main class is <code>com.beust.kobalt.MainKt</code>. Here is a typical launch configuration: Kobalt's main class is <code>com.beust.kobalt.MainKt</code>. Here is a typical launch configuration:
</p> </p>
<p align="center"> <p align="center">
<img width="99%" class="img-rounded" src="../pics/launch-configuration.png"/> <img width="99%" class="img-rounded" src="../pics/launch-configuration.png"/>
</p> </p>
<p> <p>
A few observations: A few observations:
<ul> <ul>
@ -80,14 +73,11 @@
name and thread information to each log line.</li> name and thread information to each log line.</li>
<li>Checking the "Single instance" box is useful to avoid duplicating these launch configurations.</li> <li>Checking the "Single instance" box is useful to avoid duplicating these launch configurations.</li>
</ul> </ul>
</p> </p>
</div> </div>
<!-- Table of contents --> <!-- Table of contents -->
<div class="col-md-3" id="table-of-contents"> <div class="col-md-3" id="table-of-contents">
</div> </div>
<!-- Bootstrap core JavaScript <!-- Bootstrap core JavaScript
================================================== --> ================================================== -->
<!-- Placed at the end of the document so the pages load faster --> <!-- Placed at the end of the document so the pages load faster -->
@ -95,7 +85,6 @@
<script src="../bootstrap/dist/js/bootstrap.min.js"></script> <script src="../bootstrap/dist/js/bootstrap.min.js"></script>
<script src="../js/kobalt.js"></script> <script src="../js/kobalt.js"></script>
<script>generateKobalt(6);</script> <script>generateKobalt(6);</script>
<!-- <!--
<script src="../../assets/js/docs.min.js"></script> <script src="../../assets/js/docs.min.js"></script>
--> -->
@ -103,5 +92,4 @@
<!-- <!--
<script src="../../assets/js/ie10-viewport-bug-workaround.js"></script> <script src="../../assets/js/ie10-viewport-bug-workaround.js"></script>
--> -->
</body> </body>

4
css/kobalt.css
View file

@ -2,6 +2,10 @@
* Kobalt CSS * Kobalt CSS
*/ */
.features {
font-size: 1.5em;
}
code { code {
background-color: #ffffff; background-color: #ffffff;
} }

23
documentation/index.html
View file

@ -548,29 +548,6 @@ dependencies {
"com.squareup.okhttp:okhttp:2.5.0", "com.squareup.okhttp:okhttp:2.5.0",
</pre> </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> </div>

3
getting-started/index.html
View file

@ -57,9 +57,6 @@
<!-- Main component for a primary marketing message or call to action --> <!-- Main component for a primary marketing message or call to action -->
<div class="jumbotron"> <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> <p>

14
home/index.html
View file

@ -56,18 +56,18 @@
<!-- Main component for a primary marketing message or call to action --> <!-- Main component for a primary marketing message or call to action -->
<div class="jumbotron"> <div class="jumbotron">
<h1>Kobalt: friendly, fast build system</h1> <h1>Kobalt: friendly, fast build system</h1>
<img src="../pics/auto-completion.png" class="img-rounded"/>
</div> </div>
<!-- Main content --> <!-- Main content -->
<div class="col-md-9"> <div class="col-md-9">
<img src="../pics/auto-completion.png" class="img-rounded"/>
<h2 class="section" id="overview">Features</h2> <h2 class="section" id="overview">Features</h2>
<ul> <ul class="features">
<li><h4>Intuitive DSL and plug-in architecture</h4></li> <li>Clean, easy-to-use syntax for build files</li>
<li><h4>Fast builds</h4></li> <li>Build file auto-completion from your favorite IDE</li>
<li><h4>Build file auto-completion from your favorite IDE</h4></li> <li>Intuitive plug-in architecture</li>
<li><h4>A cleaner syntax than Ant, Maven, Gradle, or SBT</h4></li> <li>Fast builds</li>
</ul> </ul>
</p> </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, ...). <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> </ul>
<h2 id="path">The path to Kobalt 1.0</h2> <h2 class="section" id="path">Status</h2>
<p> <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: 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: