Skip to content

Commit

Permalink
README tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
martinbonnin committed Feb 19, 2024
1 parent 70161a8 commit a04898e
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 6 deletions.
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Gratatouille enforces a clear separation between your plugin logic (**implementa
* [Parallel execution](#parallel-task-execution-by-default)
* [Compile-time task wiring](#compile-time-task-wiring)

Check out the [sample-plugin](sample-plugin) and [sample-app](sample-app).

# Quick Start

## Step 1/2: `com.gradleup.gratatouille.implementation`
Expand Down Expand Up @@ -91,7 +93,7 @@ gradlePlugin {
}
```

In your plugin code, use `Project.registerPrepareIngredientsTask()` to register the task:
In your plugin code, use `Project.register${TaskAction}Task()` to register the task:

```kotlin
override fun apply(project: Project) {
Expand Down Expand Up @@ -217,8 +219,3 @@ Finally, Gratatouille encourages exposing extensions to users instead of task cl

When a task has a high number of inputs, it can become hard to track which ones have been wired and which ones haven't. By using a central registration point, Gratatouille enforces at build time that all inputs/outputs have been properly wired.
# Sample plugin
* Open [sample-plugin](sample-plugin) in IntelliJ for an example plugin.
* Open [sample-app](sample-app) in IntelliJ and run `./gradlew -p sample-app cook` for an example app using the example plugin.
5 changes: 5 additions & 0 deletions sample-app/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
To see the plugin in action, run:

```
./gradlew -p sample-app cook
````
8 changes: 8 additions & 0 deletions sample-plugin/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Sample plugin

The tasks actions are in [implementation/src/main/kotlin/recipes/](implementation/src/main/kotlin/recipes/).

The wiring logic is in [gradle-plugin/src/main/kotlin/recipes/RecipesPlugin.kt](gradle-plugin/src/main/kotlin/recipes/RecipesPlugin.kt).

Generated sources are generated in `implementation/build/generated/ksp/main`. They are also extracted in `gradle-plugin/build/extractGratatouilleSources`.

0 comments on commit a04898e

Please sign in to comment.