Skip to content

Commit

Permalink
Add more detailed instructions for localDist task
Browse files Browse the repository at this point in the history
Indicates how to add the generated list file to JOSM, also
mentions that `file:/` is required, as the version in master
prints to the gradle log as well
  • Loading branch information
NLthijs48 committed Apr 21, 2022
1 parent ebbb180 commit 6a4a205
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/Tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,16 @@ 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.

## Group JOSM-i18n
Expand Down

0 comments on commit 6a4a205

Please sign in to comment.