Update build instructions in ReadMe to include gradle build step.

Also update links and overall readme structure.
This commit is contained in:
Ilya Gorbunov
2017-04-07 03:48:57 +03:00
parent f5647fb27f
commit 5aabcb6ea3
7 changed files with 96 additions and 79 deletions
+9 -6
View File
@@ -1,14 +1,17 @@
## The Kotlin Standard Library
This module creates the [standard library for kotlin](http://jetbrains.github.com/kotlin/versions/snapshot/apidocs/index.html).
This module creates the [standard library for kotlin](http://kotlinlang.org/api/latest/jvm/stdlib/index.html).
### Notes for contributors
We use some code generation to apply the various collection-like methods to various different types like arrays, strings, kotlin.Iterable and java.lang.Iterable etc.
We use some code generation to generate the various utility extension function for the various collection-like types like arrays, strings, `Collection<T>`, `Sequence<T>`, `Map<K, V>` etc.
To run the code generator from a kotlin checkout
These sources are placed into `generated` folder and their names are prefixed with the underscore, for example `generated/_Collections.kt`
cd libraries/tools/kotlin-stdlib-gen
mvn compile exec:java
To run the code generator from the `libraries` directory of a kotlin checkout, use the following command:
This then runs the [GenerateStandardLib.kt](https://github.com/JetBrains/kotlin/blob/master/libraries/tools/kotlin-stdlib-gen/src/generators/GenerateStandardLib.kt) script to create the source from the files for java.lang.Iterable<T> and java.util.Collection etc.
./gradlew :tools:kotlin-stdlib-gen:run
> Note: on Windows type `gradlew` without the leading `./`
This then runs the script which generates a significant part of stdlib sources from the [templates](https://github.com/JetBrains/kotlin/tree/master/libraries/tools/kotlin-stdlib-gen/src/templates) authored with a special kotlin based DSL.
+5 -1
View File
@@ -1,5 +1,9 @@
## Kotlin Standard Library for JS
This module produces a `kotlin-stdlib-js` jar which contains all the Kotlin source code for the runtime and standard kotlin library code (both definitions and implementation code) compiled to JavaScript.
The tests of this module can be run and debugged inside any browser by opening the **web/index.html** file in this directory to run the test cases using [Qunit](http://qunitjs.com/).
You should execute `:karmaDependencies` gradle task before running these tests to fetch the required Qunit dependency.
You should execute `karmaDependencies` gradle task before running these tests to fetch the required Qunit dependency.
These tests are also run during CI build with [gradle karma plugin](https://github.com/craigburke/karma-gradle) in PhantomJS browser.