Skip to content

Commit 864b867

Browse files
Add instrucion on gradle depenedcies setup
1 parent 6851429 commit 864b867

1 file changed

Lines changed: 32 additions & 5 deletions

File tree

README.adoc

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,36 @@
22

33
*skainet* is an open-source deep learning framework written in Kotlin, designed with developers in mind to enable the creation modern AI powered applications with ease.
44

5-
== publishing into local maven repository
5+
Here’s a concise instruction snippet for setting up dependencies in Gradle KTS to consume your open-source project:
66

7-
[source, shell]
8-
----
9-
./gradlew clean publishToMavenLocal
10-
----
7+
---
8+
9+
### Usage:
10+
11+
1. **Configure repository**
12+
Add the following to your project's `build.gradle.kts`:
13+
14+
```kotlin
15+
repositories {
16+
maven {
17+
url = uri("https://maven.pkg.github.com/sk-ai-net/skainet")
18+
credentials {
19+
username = providers.gradleProperty("gpr.user")
20+
.orElse(System.getenv("GITHUB_ACTOR"))
21+
.get()
22+
password = providers.gradleProperty("gpr.token")
23+
.orElse(System.getenv("GITHUB_TOKEN"))
24+
.get()
25+
}
26+
}
27+
}
28+
```
29+
30+
2. **Set GitHub credentials**
31+
Ensure you provide your GitHub username (`gpr.user`) and a personal access token (`gpr.token`) with package read permission.
32+
33+
[See the official GitHub docs for more details](https://docs.github.com/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry)
34+
35+
36+
37+
---

0 commit comments

Comments
 (0)