Refer to wiki for documentation

This will reduce the number of commits (and merges between version
branches) needed as we update & improve our docs.

Author: DenWav

build-logic/src/main/kotlin/io/papermc/mache/tasks/CopyVersion.kt

@@ -18,11 +18,11 @@ import org.gradle.api.tasks.options.Option
 @UntrackedTask(because = "CLI command")
 abstract class CopyVersion : DefaultTask() {
 
-    @get:Option(option = "from-version", description = "The version to copy")
+    @get:Option(option = "from", description = "The version to copy")
     @get:Input
     abstract val fromVersion: Property<String>
 
-    @get:Option(option = "to-version", description = "The target version")
+    @get:Option(option = "to", description = "The target version")
     @get:Input
     abstract val toVersion: Property<String>
 

build-logic/src/main/kotlin/io/papermc/mache/tasks/MigrateVersion.kt

@@ -23,11 +23,11 @@ import org.gradle.api.tasks.options.Option
 @UntrackedTask(because = "CLI command, always migrate")
 abstract class MigrateVersion : DefaultTask() {
 
-    @get:Option(option = "from-version", description = "The version to migrate.")
+    @get:Option(option = "from", description = "The version to migrate.")
     @get:Input
     abstract val fromVersion: Property<String>
 
-    @get:Option(option = "to-version", description = "The new version to migrate to.")
+    @get:Option(option = "to", description = "The new version to migrate to.")
     @get:Input
     abstract val toVersion: Property<String>
 

build-logic/src/main/kotlin/io/papermc/mache/tasks/OpenVersion.kt

@@ -41,7 +41,7 @@ import org.gradle.api.tasks.options.Option
 abstract class OpenVersion : DefaultTask() {
 
     @get:Input
-    @get:Option(option = "version-name", description = "The version to open.")
+    @get:Option(option = "ver", description = "The version to open.")
     abstract val versionName: Property<String>
 
     @get:Input

build.gradle.kts

@@ -13,7 +13,7 @@ val mcManifestUrl = "https://piston-meta.mojang.com/mc/game/version_manifest_v2.
 val mcManifestFile: RegularFile = layout.dotGradleDirectory.file(MC_MANIFEST)
 download.download(mcManifestUrl, mcManifestFile)
 
-tasks.register("openVersion", OpenVersion::class) {
+tasks.register("open", OpenVersion::class) {
     repoUrl.set(REPO_URL)
 }
 

readme.md

@@ -1,7 +1,7 @@
 Mâché
 =====
 
-Mache (from [papier-mâché](https://en.wikipedia.org/wiki/Papier-m%C3%A2ch%C3%A9)) is an environment which aims to
+Mâché (from [papier-mâché](https://en.wikipedia.org/wiki/Papier-m%C3%A2ch%C3%A9)) is an environment which aims to
 provide a clean-slate, fully compilable and workable decompiled Minecraft server source code. This serves as the base
 for the PaperMC Minecraft server project, of which Paper's patches will apply to it. This can of course also be used by
 anyone else who wants to use it for their own purposes.
@@ -16,36 +16,18 @@ Goal
 The current goal of this project is to provide the Minecraft source set as un-modified as possible. The patches present
 are only for allowing the decompiled code to be re-compilable. We may still end up publishing additional builds for a
 single Minecraft version, however, as we bring in updates from [codebook](https://github.com/PaperMC/codebook),
-[VineFlower](https://github.com/Vineflower/vineflower), or [Parchment](https://github.com/ParchmentMC/Parchment).
+[VineFlower](https://github.com/Vineflower/vineflower),
+[AutoRenamingTool](https://github.com/neoforged/AutoRenamingTool) or
+[Parchment](https://github.com/ParchmentMC/Parchment).
 
 The Minecraft sources generated here use Mojang's official mappings, and we use Parchment mappings for parameter name
 mappings. Local variable mappings are generated at remap time via
 [codebook](https://github.com/PaperMC/codebook).
 
-Usage
------
+Documentation
+-------------
 
-Set up all present versions:
-```sh
-./gradlew setup
-```
-
-Set up a specific version:
-```sh
-./gradlew :versions:1.20.1:setup
-```
-
-Patches
--------
-
-If you make changes, you can re-build patches with:
-```sh
-./gradlew :versions:1.20.1:rebuildPatches
-```
-
-You may notice that the source set directory for each version is also its own tiny git repository. This repo is not used
-at all in the process of generating or applying patches, it exists solely to improve the developer experience, making it
-easier to view your current changes, and the changes pulled in from the existing patches.
+[See the wiki for docs on usage and further details.](https://github.com/PaperMC/mache/wiki)
 
 License
 -------