Skip to content

Commit ffe2ac7

Browse files
committed
docs: add note about windows and docker desktop
1 parent 8b81bc4 commit ffe2ac7

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

README.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,38 @@
11
## Dev-Tools
22
### Repository
3-
The plugins are published to a private repository that you need to add to the plugin repositories.
4-
> **settings.gradle.kts**
5-
> ```kotlin
6-
> pluginManagement {
7-
> repositories {
8-
> maven("https://artifacts.wolfyscript.com/artifactory/gradle-dev")
9-
> // ... (other repos)
10-
> }
11-
> }
12-
> ```
3+
The plugins are published to a private repository that you need to add to the plugin repositories.
4+
5+
**settings.gradle.kts**
6+
```kotlin
7+
pluginManagement {
8+
repositories {
9+
maven("https://artifacts.wolfyscript.com/artifactory/gradle-dev")
10+
// ... (other repos)
11+
}
12+
}
13+
```
1314

1415
# Docker Run Gradle Plugin
15-
Inspired by docker-run module in [palantir/gradle-docker](https://github.com/palantir/gradle-docker), but with a slightly different behaviour.
16+
This plugin simplifies running docker containers using Gradle and compose custom setups.
1617

1718
Add the plugin dependency to the `build.gradle.kts`
1819
```kotlin
1920
plugins {
2021
id("com.wolfyscript.devtools.docker.run") version ("a2.1.0.0")
2122
}
2223
```
24+
> [!note]
25+
>
26+
> The plugin has only been tested on **Linux** using a local **Docker Engine** install.
27+
> The plugin runs all the docker commands on the command line provided by Gradle.
28+
> It is unknown how well it functions on Windows and/or Docker Desktop.
29+
>
30+
2331

2432
## Default Behaviour
2533
The plugin provides an extension `dockerRun` and 3 tasks (`dockerRun`, `dockerStatus`, and `dockerStop`).
2634

27-
Use the extension to configure the container to run, or specify defaults for custom tasks
35+
Use the extension to configure the container to run or specify defaults for custom tasks
2836
```kotlin
2937
dockerRun {
3038
name.set("test_minecraft_server")

0 commit comments

Comments
 (0)