source: osm/applications/editors/josm/plugins/mirrored_download/README.template@ 27678

Last change on this file since 27678 was 27678, checked in by roland, 13 years ago

Started plugin mirrored_download.

File size: 2.5 KB
Line 
1README
2======
3
4This is a template project structure for a JOSM plugin.
5
6Layout
7======
8+--- src source of your plugin
9 |- images images your plugin needs
10 |- resources resources your plugin needs
11
12 LICENSE license file
13 README README for your plugin
14
15 README.template this file
16
17
18Build
19=====
20A JOSM plugin is built as a single jar. We use ant to build.
21
22See build.xml in this directory and update the plugin specific properties in the
23configuration section.
24
25
26Maintaining versions
27====================
28There are two versions maintained with each plugin:
29 1) the main version
30 You have to manually set the plugins main version in the build script.
31 Set the property plugin.main.version in build.xml accordingly.
32
33 2) the build version
34 The build version is unique for every build of the plugin. It is equal
35 to the SVN revision of your plugin directory.
36
37 Both the main version and the build version are included in properties of the plugins
38 manifest:
39 Plugin-Version the build version
40 Plugin-Mainversion the main version
41
42 JOSM automatically detects whether a plugin needs to be upgraded. It compares the build
43 version of the currently installed plugin jar with the build version of the plugin jar in
44 the SVN. The main version is irrelevant for this process.
45
46 Making your plugin available to JOSM users
47 ===========================================
48 When a plugin jar is checked into SVN a script updates the plugins list on the JOSM wiki:
49 http://josm.openstreetmap.de/wiki/Plugins
50 JOSM retrieves the list of available plugins and their build versions from this list.
51
52 commit publish read
53 meta data meta data
54 Build ==> SVN =======> JOSM Wiki <======= JOSM
55 ^
56 ==================================
57 fetch current plugin jar
58
59 Note that you have to manually publish (commit) your plugin jar. There is no nightly build
60 in place. Everything else (pulishing meta data, updating plugins in the client) is then handled
61 by automatic processes.
62
63See also
64========
65* Developing Plugins
66 http://josm.openstreetmap.de/wiki/DevelopingPlugins
67
68* List of JOSM Plugins
69 http://josm.openstreetmap.de/wiki/Plugins
70
71
72
73
74
75
Note: See TracBrowser for help on using the repository browser.