Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Juuxel committed Jun 13, 2021
1 parent ef26063 commit 3ea0e8e
Showing 1 changed file with 19 additions and 6 deletions.
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,14 @@
A Loom addon that adds [Quiltflower](https://github.com/QuiltMC/Quiltflower) as a Loom decompiler
for non-Quilt distributions of Loom (upstream, Architectury etc.).

## Usage
- [Getting started](#getting-started)
- [Fabric projects](#fabric-projects)
- [Architectury projects](#architectury-projects)
- [Configuration](#configuration)

See further down for Architectury instructions.
## Getting started

### Usage with Fabric projects
### Fabric projects

1. Add the Cotton maven repository to settings.gradle:
```diff
Expand All @@ -32,14 +35,14 @@ See further down for Architectury instructions.
```diff
plugins {
id 'fabric-loom' version '0.8-SNAPSHOT'
+ id 'io.github.juuxel.loom-quiltflower' version '1.0.1+quiltflower.1.4.0'
+ id 'io.github.juuxel.loom-quiltflower' version '1.1.0'
id 'maven-publish'
}
```

3. Instead of `genSources`, you can now use `genSourcesWithQuiltflower`.

### Usage with Architectury projects
### Architectury projects

1. Add the Cotton maven repository to settings.gradle:
```diff
Expand All @@ -62,7 +65,7 @@ See further down for Architectury instructions.
plugins {
id "architectury-plugin" version "3.1-SNAPSHOT"
id "dev.architectury.loom" version "0.7.2-SNAPSHOT" apply false
+ id 'io.github.juuxel.loom-quiltflower' version '1.0.1+quiltflower.1.4.0' apply false
+ id 'io.github.juuxel.loom-quiltflower' version '1.1.0' apply false
}
```

Expand All @@ -77,3 +80,13 @@ See further down for Architectury instructions.
> Note: this can also be done in the subprojects' `plugins` blocks.
4. Instead of `genSources`, you can now use `genSourcesWithQuiltflower`.

## Configuration

You can configure the used version of Quiltflower with the `loomQuiltflower` extension:

```groovy
loomQuiltflower {
quiltflowerVersion.set("1.4.0")
}
```

0 comments on commit 3ea0e8e

Please sign in to comment.