diff --git a/README.md b/README.md index 9c8a6b5..433ce07 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,25 @@ This plugin brings RapiD information into JOSM. ## Installation -To use this plugin, [install JOSM](https://josm.openstreetmap.de/wiki/Download) and then [in the preferences menu install the **rapid** plugin](https://josm.openstreetmap.de/wiki/Help/Preferences/Plugins#AutomaticinstallationviaPreferencesmenu) **not currently in the JOSM plugin menu (TODO)** +To use this plugin, [install JOSM](https://josm.openstreetmap.de/wiki/Download) and then [in the preferences menu install the **rapid** plugin](https://josm.openstreetmap.de/wiki/Help/Preferences/Plugins#AutomaticinstallationviaPreferencesmenu) + +## Usage +1. Open JOSM +2. Install the plugin ("JOSM Preferences" -> "Plugins" -> "rapid") +3. Download data ("File" -> "Download Data") or just use the "Download data" button on the toolbar +4. Download RapiD data ("Data" -> "RapiD") +5. Switch to the "RapiD" layer (if you don't have one, file a bug report with the location) +6. If you are in a location where Facebook has run its AI, *or* Microsoft has provided building footprints, you should see data. If you do not, check your paintstyles (some paintstyles make buildings *really* hard to see). + +### Optional JOSM Setup +1. Open JOSM +2. Add the "RapiD" paintstyle by going to "Map Settings" -> "Map Paint Styles" -> the plus sign next to "Active styles" -> enter `https://gitlab.com/smocktaylor/rapid/raw/master/src/resources/styles/standard/rapid.mapcss` in the "URL / File" field. + +## Information +* [RapiD](https://mapwith.ai/rapid) +* [HOT Tasking Manager + RapiD] (https://tasks-assisted.hotosm.org/) +* [RapiD source code and country requests](https://github.com/facebookincubator/RapiD) +* [mapwith.ai](https://mapwith.ai/) ## Contributing