Files
kotlin-fork/libraries/stdlib/ReadMe.md
T
2019-02-19 21:35:36 +01:00

21 lines
1012 B
Markdown

## The Kotlin Standard Library
This module creates the [standard library for Kotlin](https://kotlinlang.org/api/latest/jvm/stdlib/index.html).
### Notes for contributors
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.
These sources are placed into `generated` folder and their names are prefixed with the underscore, for example `generated/_Collections.kt`
To run the code generator use the following command in the root directory of the project:
./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](../tools/kotlin-stdlib-gen/src/templates) authored with a special kotlin based DSL.
### Usage samples
If you want to author samples for the standard library, please head to [the samples readme](samples/ReadMe.md).