Skip to content

Commit

Permalink
Add README for settings-include-dsl
Browse files Browse the repository at this point in the history
  • Loading branch information
LouisCAD committed Nov 8, 2023
1 parent aee83c9 commit efd2863
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions gradle-plugins/settings-include-dsl/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Settings include DSL

## Example

Write this:

```.gradle.kts
include {
"someProject" {
"thingA"()
"thingB"()
}
"whatever"()
}
```

Instead of that:

```gradle.kts
include("someProject:thingA")
include("someProject:thingB")
include("whatever")
```

## How to add to your project

Go in the `settings.gradle.kts` file, located at the root of your Gradle project.

Add the following line into the `plugins { … }` block (add one at the top of the file it there's none):

```gradle.kts
id("org.splitties.incubator.settings-include-dsl") version "0.2.6-SNAPSHOT"
```

0 comments on commit efd2863

Please sign in to comment.