Skip to content

Commit cfd05a1

Browse files
add Maven to readme and improve SetupMaven.md
1 parent b0c78c1 commit cfd05a1

File tree

4 files changed

+48
-8
lines changed

4 files changed

+48
-8
lines changed

README.md

Lines changed: 41 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -114,12 +114,12 @@ Or manually specify the version:
114114
> ```
115115
116116
Refer to the
117-
[Get started with Kotlin DataFrame in Kotlin Notebook](https://kotlin.github.io/dataframe/gettingstartedkotlinnotebook.html)
117+
[Setup Kotlin DataFrame in Kotlin Notebook](https://kotlin.github.io/dataframe/setupkotlinnotebook.html)
118118
for details.
119119
120120
### Gradle
121121
122-
Add dependencies in the build.gradle.kts script:
122+
Add dependencies in the `build.gradle.kts` script:
123123
124124
```kotlin
125125
dependencies {
@@ -135,12 +135,47 @@ repositories {
135135
}
136136
```
137137
138+
Refer to
139+
[Get started with Kotlin DataFrame on Gradle](https://kotlin.github.io/dataframe/setupgradle.html)
140+
for detailed setup instructions (including Groovy DSL).
141+
142+
* You can also check the [Custom Gradle Configuration](https://kotlin.github.io/dataframe/setupcustomgradle.html) if you don't need certain formats as dependencies.
143+
* For Android projects, see [Setup Kotlin DataFrame on Android](https://kotlin.github.io/dataframe/setupandroid.html).
144+
* See [IDEA Gradle example projects](examples/idea-examples)
145+
and [the Gradle project with the Kotlin DataFrame Compiler plugin](examples/kotlin-dataframe-plugin-gradle-example).
146+
138147
Refer to the
139-
[Get started with Kotlin DataFrame on Gradle](https://kotlin.github.io/dataframe/gettingstartedgradle.html)
148+
[Setup Kotlin DataFrame in Kotlin Notebook](https://kotlin.github.io/dataframe/setupkotlinnotebook.html)
140149
for details.
141-
Also, check out the [custom setup page](https://kotlin.github.io/dataframe/gettingstartedgradleadvanced.html)
142-
if you don't need some formats as dependencies,
143-
for Groovy, and for configurations specific to Android projects.
150+
151+
### Maven
152+
153+
Add dependencies in the `pom.xml` configuration file:
154+
155+
```xml
156+
<dependency>
157+
<groupId>org.jetbrains.kotlinx</groupId>
158+
<artifactId>dataframe</artifactId>
159+
<version>1.0.0-Beta4</version>
160+
</dependency>
161+
```
162+
163+
Make sure that you have `mavenCentral` in the list of repositories:
164+
165+
```xml
166+
<repositories>
167+
<repository>
168+
<id>mavenCentral</id>
169+
<url>https://repo1.maven.org/maven2/</url>
170+
</repository>
171+
</repositories>
172+
```
173+
174+
Refer to
175+
[Get started with Kotlin DataFrame on Maven](https://kotlin.github.io/dataframe/setupmaven.html).
176+
177+
* See [the Maven project with the Kotlin DataFrame Compiler plugin](examples/kotlin-dataframe-plugin-gradle-example).
178+
144179
145180
## Code example
146181

docs/StardustDocs/topics/setup/SetupGradle.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,9 @@ kotlin.incremental=false
132132

133133
See [the Gradle example project with the Kotlin DataFrame Compiler Plugin enabled on GitHub](https://github.com/Kotlin/dataframe/tree/master/examples/kotlin-dataframe-plugin-gradle-example).
134134

135+
You can also
136+
[download this project](https://github.com/Kotlin/dataframe/raw/example-projects-archives/kotlin-dataframe-plugin-gradle-example.zip).
137+
135138

136139
## Next Steps
137140

docs/StardustDocs/topics/setup/SetupMaven.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ fun main() {
8080
on-the-fly in Maven projects, making development with Kotlin DataFrame faster,
8181
more convenient, and fully type- and name-safe.
8282

83-
> Requires Kotlin 2.2.20-Beta1 or higher.
83+
> Requires Kotlin 2.2.20-Beta1 or higher and IntelliJ IDEA 2025.3 or higher.
8484
> { style = "note" }
8585
8686
To enable the plugin in your Maven project, add it to the `plugins` section:
@@ -111,6 +111,9 @@ To enable the plugin in your Maven project, add it to the `plugins` section:
111111

112112
See [the Maven example project with the Kotlin DataFrame Compiler Plugin enabled on GitHub](https://github.com/Kotlin/dataframe/tree/master/examples/kotlin-dataframe-plugin-maven-example).
113113

114+
You can also
115+
[download this project](https://github.com/Kotlin/dataframe/raw/example-projects-archives/kotlin-dataframe-plugin-maven-example.zip).
116+
114117

115118
## Next Steps
116119

examples/kotlin-dataframe-plugin-maven-example/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,4 @@ as well as the latest Kotlin plugin version.
1111
1212
> [Download Kotlin DataFrame Compiler Plugin Maven Example](https://github.com/Kotlin/dataframe/raw/example-projects-archives/kotlin-dataframe-plugin-maven-example.zip)
1313
14-
1514
See also [Kotlin DataFrame Compiler Gradle Plugin Example](../kotlin-dataframe-plugin-gradle-example)

0 commit comments

Comments
 (0)