Skip to content

Commit c697cfc

Browse files
committed
Provide dependency setup instructions.
1 parent 071d911 commit c697cfc

File tree

1 file changed

+59
-3
lines changed

1 file changed

+59
-3
lines changed

README.md

Lines changed: 59 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,70 @@
22

33
Immutable collection interfaces and implementation prototypes for Kotlin ([proposal](proposal.md))
44

5+
Prototype implementation is based on [pcollections](http://pcollections.org/) (Copyright 2015 The pcollections Authors.)
6+
7+
8+
9+
## Using in your projects
10+
11+
> Note that these libraries are experimental and are subject to change.
12+
13+
The libraries are published to [kotlinx](https://bintray.com/kotlin/kotlinx/kotlinx.collections.immutable) bintray repository.
14+
15+
These libraries require kotlin compiler version to be at least `1.1.0` and
16+
require kotlin runtime of the same version as a dependency.
17+
18+
### Maven
19+
20+
Add the bintray repository to `<repositories>` section:
21+
22+
```xml
23+
<repository>
24+
<snapshots>
25+
<enabled>false</enabled>
26+
</snapshots>
27+
<id>kotlinx</id>
28+
<name>bintray</name>
29+
<url>http://dl.bintray.com/kotlin/kotlinx</url>
30+
</repository>
31+
```
32+
33+
Add dependencies (you can also add other modules that you need):
534

6-
To initialize submodules, use the following commands:
35+
```xml
36+
<dependency>
37+
<groupId>org.jetbrains.kotlinx</groupId>
38+
<artifactId>kotlinx-collections-immutable</artifactId>
39+
<version>0.1</version>
40+
</dependency>
41+
```
42+
43+
### Gradle
44+
45+
Add the bintray repository:
46+
47+
```groovy
48+
repositories {
49+
maven {
50+
url "http://dl.bintray.com/kotlin/kotlinx"
51+
}
52+
}
53+
```
54+
55+
Add the dependency:
56+
57+
```groovy
58+
compile 'org.jetbrains.kotlinx:kotlinx-collections-immutable:0.1'
59+
```
60+
61+
62+
## Building from source
63+
64+
To initialize submodules after checkout, use the following commands:
765

866
git submodule init
967
git submodule update
1068

1169
Then you can build and install artifacts to maven local with:
1270

1371
gradlew build install
14-
15-
Prototype implementation is based on [pcollections](http://pcollections.org/) (Copyright 2015 The pcollections Authors.)

0 commit comments

Comments
 (0)