source: osm/applications/editors/josm/plugins/00_README@ 35976

Last change on this file since 35976 was 35544, checked in by stoecker, 4 years ago

update instructions for moved repo

File size: 2.1 KB
Line 
1This is the SVN repository for JOSM plugins. JOSM plugins are extensions of the OSM editor JOSM,
2see https://josm.openstreetmap.de/.
3
4This repository includes the source and the current builds for each plugin:
5
6* the source is maintained in the respective sub directories, i.e. 'wmsplugin' for the wmsplugin
7* the current builds are available in '../dist'
8
9
10FAQ
11===
12* How can I check in my own plugin?
13
14 - You need an account for the plugin subversion repository, see
15 https://josm.openstreetmap.de/wiki/DevelopersGuide/DevelopingPlugins#ManagingaplugininpluginSVN
16
17 - Make sure to check out the tree https://josm.openstreetmap.de/osmsvn/applications/editors/josm/
18 svn checkout https://josm.openstreetmap.de/osmsvn/applications/editors/josm/
19
20 This will also check out the JOSM source from https://josm.openstreetmap.de/svn.
21
22 Note that the build environment is not complete if you check out
23 https://josm.openstreetmap.de/osmsvn/applications/editors/josm/plugins/ only.
24
25 - Create your own plugin directory. You may create a copy of the template directory
26 according to '00_plugin_dir_template'.
27
28* How can I build my plugin?
29
30 - Update build.xml in your plugin directory and run 'ant dist'
31
32 - You may also add your plugin to 'plugins/build.xml'
33
34 <target name="dist" depends="compile">
35 ....
36 <ant antfile="build.xml" target="dist" dir="YourPluginDir"/>
37 </target>
38
39 <target name="clean">
40 ....
41 <ant antfile="build.xml" target="clean" dir="YourPluginDir"/>
42 </target>
43
44
45* How can I make my plugin available to other JOSM users?
46
47 - The manifest of your plugin jar has to include the required meta information,
48 see https://josm.openstreetmap.de/wiki/DevelopingPlugins.
49 'build.xml' copied from '00_plugin_dir_template' will create a compliant manifest
50 file for your plugin.
51
52 - Check in your plugin jar into 'dist'. You have to do it manually.
53 There is no automatic build process. See also '00_plugin_dir_template/REAME'.
Note: See TracBrowser for help on using the repository browser.