Add screenshot to docs for localDist task

floscher · May 15, 2022 · 197e995 · 197e995
1 parent 14af73d
commit 197e995
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 10 deletions.
diff --git a/docs/Tasks.md b/docs/Tasks.md
@@ -55,18 +55,22 @@ These are three variants of the `compileJava` task, which compile against specia
 ```
 This task creates a 'plugin site' inside your `build/localDist/` directory. Point any JOSM instance at the URL, that this task reports to you and you can "download" your plugin from your `build/` directory into that JOSM instance.
 
-1. In JOSM open `Edit` > `Preferences` > `Plugins`
-2. Click `Configure sites` (bottom right corner)
-3. Click `Add`
-4. Add the full absolute path to the `build/localDist/list` file, prefixing the path with `file:/`
-    - Example for Windows: `file:/C:/my-josm-plugin/build/localDist/list`
-5. Click `Ok` to confirm
-6. Click the `Download list` button in the bottom bar
-7. Search for your plugin, and enable it using the checkbox
-8. Click `Ok` to close the preferences
-
 The task `runJosm` is the preferred (and easier) method to test drive your plugin, but in some circumstances you might not want to test in an isolated environment, but in your normal JOSM setup. If that's the case, this task is for you.
 
+1. In JOSM open `Edit` → `Preferences` → `Plugins`
+2. Make sure the `expert mode` checkbox at the bottom left corner of the window is checked.
+3. Click `Configure sites` (bottom right corner)
+4. Click `Add`
+5. Add the full absolute URL to the `build/localDist/list` file. It should be displayed at the very end of the log output of the task and include the `file:/` prefix, e.g.:
+   - `file:/C:/my-josm-plugin/build/localDist/list`
+   - `file:/home/username/my-josm-plugin/build/localDist/list`
+6. Click `Ok` to confirm in both open dialogs
+7. Click the `Download list` button in the bottom bar
+8. Search for your plugin, and enable it using the checkbox
+9. Click `Ok` to close the preferences
+
+![a screenshot highlighting the steps to install the plugin using the `localDist` task](images/tasks_localDist_screenshot.png)
+
 ## Group JOSM-i18n
 
 ### generatePot

diff --git a/docs/images/tasks_localDist_screenshot.png b/docs/images/tasks_localDist_screenshot.png
diff --git a/plugin/src/main/kotlin/org/openstreetmap/josm/gradle/plugin/task/GeneratePluginList.kt b/plugin/src/main/kotlin/org/openstreetmap/josm/gradle/plugin/task/GeneratePluginList.kt
@@ -138,6 +138,8 @@ public open class GeneratePluginList @Inject constructor(
       |${"By adding the following URL as a JOSM plugin update site (see tab 'Plugins' in expert mode), " +
         "you can load the current development state into a JOSM instance via the regular plugin update mechanism:"}
       |  ${outputFile.toURI()}
+      |
+      |(see https://gitlab.com/JOSM/gradle-josm-plugin/-/blob/main/docs/Tasks.md#localdist for more detailed instructions)
     """.trimMargin())
   }
 }