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

Last change on this file since 32291 was 14432, checked in by guggis, 16 years ago

renamed README

File size: 2.0 KB
Line 
1This is the SVN repository for JOSM plugins. JOSM plugins are extensions of the OSM editor JOSM,
2see http://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 OSM subversion repository, see
15 http://wiki.openstreetmap.org/wiki/Accounts#SVN_access_.28OSM_software.29
16
17 - Make sure to check out the tree http://svn.openstreetmap.org/applications/editors/josm/
18 (or one of its parents).
19 svn checkout http://svn.openstreetmap.org/applications/editors/josm/
20
21 This will also check out the JOSM source from http://josm.openstreetmap.de/svn.
22
23 Note that the build environment is not complete if you check out
24 http://svn.openstreetmap.org/applications/editors/josm/plugins/ only.
25
26 - Create your own plugin directory. You may create a copy of the template directory
27 according to '00_plugin_dir_template'.
28
29* How can I build my plugin?
30
31 - Update build.xml in your plugin directory and run 'ant dist'
32
33 - You may also add your plugin to 'plugins/build.xml'
34
35 <target name="dist" depends="compile">
36 ....
37 <ant antfile="build.xml" target="dist" dir="YourPluginDir"/>
38 </target>
39
40 <target name="clean">
41 ....
42 <ant antfile="build.xml" target="clean" dir="YourPluginDir"/>
43 </target>
44
45
46* How can I make my plugin available to other JOSM users?
47
48 - The manifest of your plugin jar has to include the required meta information,
49 see http://josm.openstreetmap.de/wiki/DevelopingPlugins.
50 'build.xml' copied from '00_plugin_dir_template' will create a compliant manifest
51 file for your plugin.
52
53 - Check in your plugin jar into 'dist'. You have to do it manually.
54 There is no automatic build process. See also '00_plugin_dir_template/REAME'.
55
56
Note: See TracBrowser for help on using the repository browser.