source: subversion/applications/editors/josm/plugins/conflation/README.template @ 27269

Last change on this file since 27269 was 25942, checked in by joshdoe, 8 years ago

Initial commit of incomplete and experimental simple conflation tool

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