ReadMe.md 1.8 KB
Newer Older
1 2
## Kotlin Libraries

I
Ilya Gorbunov 已提交
3
This part of the project contains the sources of the following libraries:
4

I
Ilya Gorbunov 已提交
5 6 7 8
  - [kotlin-stdlib](stdlib), the standard library for Kotlin/JVM, Kotlin/JS and its additional parts for JDK 7 and JDK 8
  - [kotlin-reflect](reflect), the library for full reflection support
  - [kotlin-test](kotlin.test), the library for multiplatform unit testing
  - [kotlin-annotations-jvm](tools/kotlin-annotations-jvm), the annotations to improve types in the Java code to look better when being consumed in the Kotlin code.
9

I
Ilya Gorbunov 已提交
10
<!--  - [kotlin-annotations-android](tools/kotlin-annotations-android) -->
11

I
Ilya Gorbunov 已提交
12
These libraries are built as a part of the [root](../) Gradle project.
13 14


I
Ilya Gorbunov 已提交
15
## Kotlin Maven Tools
16

I
Ilya Gorbunov 已提交
17
<!-- TODO: Move to another root -->
18

19
This area of the project is the root for Maven build.
20

I
Ilya Gorbunov 已提交
21
You can work with the maven modules of this maven project in IDEA from the [root IDEA project](../ReadMe.md#working-in-idea). After importing you'll be able to explore maven projects and run goals directly from IDEA with the instruments on the right sidebar.
22

I
Ilya Gorbunov 已提交
23
### Building
24

25
You need to install a recent (at least 3.3) [Maven](https://maven.apache.org/) distribution.
26

I
Ilya Gorbunov 已提交
27
Before building this Maven project you need to build and install the required artifacts built with Gradle to the local maven repository, by issuing the following command in the root project:
28

I
Ilya Gorbunov 已提交
29
    ./gradlew install
30

I
Ilya Gorbunov 已提交
31
> Note: on Windows type `gradlew` without the leading `./`
32

I
Ilya Gorbunov 已提交
33 34
This command assembles and puts the artifacts to the local maven repository to be used by the subsequent maven build.
See also [root ReadMe.md, section "Building"](../ReadMe.md#building).
S
Sergey Igushkin 已提交
35

36

I
Ilya Gorbunov 已提交
37
Then you can build maven artifacts with Maven:
38

I
Ilya Gorbunov 已提交
39
    mvn install
40

I
Ilya Gorbunov 已提交
41
If your maven build is failing with Out-Of-Memory errors, set JVM options for maven in `MAVEN_OPTS` environment variable like this:
42

I
Ilya Gorbunov 已提交
43
    MAVEN_OPTS="-Xmx2G"
44