source: josm/trunk/README@ 16006

Last change on this file since 16006 was 16006, checked in by Don-vip, 4 years ago

see #18140 - reorganization of data(_nodist), images(_nodist), styles(_nodist), IDE and native files in a more practical file tree.

  • Everything belonging to the jar is now in resources (data, images, styles)
  • Everything not belonging to the jar is now in nodist (data, images, styles)
  • Everything related to OS native functions is now in native (linux, macosx, windows)
  • Everything related to an IDE is now in ide (eclipse, netbeans)
  • Property svn:eol-style set to native
  • Property svn:mime-type set to text/plain;charset=utf-8
File size: 12.4 KB
1Supplemental information for JOSM -- the Java OpenStreetMap Editor
4 I. Install & Launch
7Installation notes
9To run JOSM, you need:
11* The JOSM .jar file, e.g., josm-tested.jar or josm-latest.jar
12* Java Runtime Environment (JRE) 8, or later.
15How to get Java Runtime Environment
17You need JRE Version 8, or later.
19Microsoft Windows and Apple Mac OS X users should visit
20and download the latest Java executable for their system.
22Linux users should visit
23There is a Linux binary installer, which you must execute from a console, or
24use the mechanism of your distribution's packaging system.
27How to launch
29Microsoft Windows users launch by double-clicking on the .jar file.
30If this does not work, open a command shell and type
31"java -jar josm-latest.jar" in the directory that holds the file. (Please
32replace josm-latest.jar with the name of your .jar file, if you aren't using
33the latest version.)
35Under Linux, open a shell, go to the file directory and type
36"java -jar josm-latest.jar" to launch. If this does not work, try to set
37your JAVA_HOME variable to the java executable location (the root location,
38not the bin).
40macOS users just click on the .jar file icon.
43 II. Development
46How to get the source code
48Download it directly from the subversion at
49 To use the command line subversion
50client, type
52svn co josm
55Files & directories
57This is an overview of the files and directories in the JOSM code repository:
58- build.xml ant build file (standard way to create a JOSM binary)
59- CONTRIBUTION list of major code contributors
60- gpl-2.0.txt, gpl-3.0.txt full text of the GNU General Public License
61- ide IDE-specific files
62 - eclipse/ preconfigured Eclipse configuration files
63 - netbeans/ preconfigured Netbeans project
64- josm.jnlp Java Web Start launcher file (used on the website for the tested version)
65- josm-latest.jnlp Java Web Start launcher file (used on the website for the latest version)
66- LICENSE the JOSM license terms
67- native/ OS-specific files
68 - linux/ files useful for Linux distributions, including Appdata files, .desktop
69 files, Debian/Ubuntu scripts, man pages, icons, etc.
70 - macosx/ files needed to create the MacOS X package
71 - windows/ files needed to create the Windows installer
72- nodist/ files not included in JOSM binary
73 - data/ data files that are useful for development, but not distributed
74 - exif-direction-example.jpg
75 sample image, that contains direction information in the EXIF header
76 (keys: Exif.GPSInfo.GPSImgDirectionRef, Exif.GPSInfo.GPSImgDirection)
77 - filterTests.osm used for unit testing of the filter feature
78 (see test/unit/org/openstreetmap/josm/data/osm/
79 - Join_Areas_Tests.osm some examples to test the 'join areas' feature
80 - *.* various other data files used for unit testing and as reference file
81 - projection/ projection files
82 - *.gsb NTv2 grid files for projection support, downloaded by the
83 client on demand (see CONTRIBUTION)
84 - CHENyx06-Distribution.pdf
85 archive of terms of use for the CHENyx06.gsb file
86 - epsg EPSG data file, taken from the proj.4 project
87 (see
88 - esri ESRI data file, taken from the proj.4 project
89 (see
90 - josm-epsg customizations to the epsg file, used together with the epsg file
91 to generate data/projection/custom-epsg
93 - projection-reference-data.csv
94 reference data for projection tests
95 (see test/unit/org/openstreetmap/josm/data/projection/
96 - projection-regression-test-data.csv
97 regression data for projection tests
98 (see test/unit/org/openstreetmap/josm/data/projection/
99 - trans/*.lang translation data for files that are not distributed, but used
100 by the server for localization of the services;
101 currently contains plugin descriptions in order to include translations
102 in the downloaded plugin list
103 - images/ images, which are not for distribution, but may be useful later (e.g. high
104 resolution and vector versions)
105 - styles/ files needed for map style maintenance
106 - potlatch2/README infos on how to update the Potlatch 2 style from upstream sources
107- patches/ patches for external libraries used in JOSM (see below)
108- README this file
109- resources/ resource files that will be included in the JOSM jar file
110 - data/ data files that will be included in the JOSM jar file
111 - fonts/ font files used for map rendering
112 - gpx/ different color gradients for gpx drawing
113 - projection/ projection files
114 - custom-epsg list of projection definitions, auto-generated file created by ant task 'epsg'
115 - security/*.pem certificates that we like to accept for TLS connections, but are missing in the
116 default Java certificate store
117 - validator/ data files used by the JOSM validator
118 - *.cfg files designed for the old tagchecker, still in use
119 - *.mapcss default validation rules for the MapCSS-based tagchecker
120 - boundaries.osm OSM file containing boundary data for the states of the earth, including
121 data for right and left-hand traffic
122 - defaultpresets.xml data file for the core tagging presets
123 - help-browser.css CSS file for the help sites (HTML content is downloaded from the website
124 on demand, but displayed inside the programm in a Java web browser component.)
125 - overpass-wizard.js Javascript code to provide a wizard-GUI for creating Overpass requests
126 (external library, see
127 - *.lang translation data
128 - *.xsd xml schema files for validation of configuration files
129 - images/ images distributed with the JOSM binary
130 - icons images for the Potlatch 2 style
131 - presets images for the main mappaint style and the internal presets
132 - styles/ map styles included in JOSM
133- scripts/ various scripts used by JOSM developers
134 -
135 called from the ant build file to combine the files epsg and josm-epsg
136 to create the custom-epsg file for distribution
137 - tool to find all used icons and allows deleting unused icons
138 searches also for images with incompatible svg code
139 - optimize-images short script to decrease size of PNG images
140 - developer tool to replace "@since xxx" in Javadoc by the upcoming revision number
141 -
142 script to compare and analyse the differences of the editor layer index and the
143 JOSM imagery list (see
144 - extracts tag information for the taginfo project
145- src/ the source code of the application
146- start.html HTML page to run the applet version of JOSM
147- test/ automated software tests
148 - data/ resources used for some tests
149 - functional/ functional tests (source code)
150 - lib/ libraries needed for (some of) the tests, including JUnit
151 - performance/ performance tests (source code)
152 - unit/ unit tests (source code)
153- tools/ libraries and tools that help in the development process
154 - animal-sniffer-ant-tasks.jar
155 used to build and check code signatures to ensure plugins binary compatibility
156 - appbundler-1.0ea.jar used to build Mac OS X package
157 - checkstyle/ libs and config files for checkstyle (automatically detects code style
158 problems in source code); can be launched as an ant target in build.xml
159 - error_prone_ant.jar used to detect code errors during compilation
160 - ivy/ Apache Ivy binary, configuration file, and downloaded dependencies
161 - jacocoant.jar used to include coverage data into JUnit test reports
162 - japicc/ used to generate a compatibility report between optimized jar and normal one
163 - javacc.jar used in the build process to generate some .java files from a javacc source file
164 (src/org/openstreetmap/josm/gui/mappaint/mapcss/MapCSSParser.jj)
165 - proguard.jar optimize final binary jar - see build.xml (not used in production so far)
166 - spotbugs/ libs and config files for spotbugs (automatically detects common bugs and potential
167 problems in source code); can be launched as an ant target in build.xml
168 - xmltask.jar used to edit XML files from Ant for the OSX package
170The 'patches' directory
172Some libraries that JOSM depends on, are patched for various reasons. The
173files in the patches directory can be used to roll back these customizations.
174This is useful in order to
175 * inspect the changes
176 * update to a newer version of the library but keep the modifications
178You can use 'quilt' to manage the patches. E.g. the following command applies all of them:
180 $ quilt push -a
182Of course, it is also possible to apply the patch files manually one by one.
184Third party libraries
186There are some third party libraries which are directly included in the source code tree, in particular:
188* jmapviewer: Java component to browse a TMS map
189 src/org/openstreetmap/gui (svn external)
190 ->
191* Apache commons compress: Support for bzip2 compression when opening files
192 src/org/apache/commons/compress/compressors (svn external)
193 ->
194* Apache commons validator: Improved validator routines
195 src/org/openstreetmap/josm/data/validation/routines
196 ->
197* SVG Salamander: Support for SVG image format
198 src/com/kitfox/svg
199 ->
200* Metadata Extractor: Read EXIF Metadata of photos
201 src/com/drew
202 ->
203* Signpost: OAuth library
204 src/oauth, src/com/google
205 ->
206* MultiSplitPane: Small lib for GUI layout management
207 src/org/openstreetmap/josm/gui/,
208 ->
209 ->
210* swinghelper: Class CheckThreadViolationRepaintManager to find classpath violations
211 src/org/jdesktop/swinghelper/debug/
212 ->
213* xz extractor
214 src/org/tukaani
215 ->
216* OpeningHoursParser (MIT license)
217 ->
Note: See TracBrowser for help on using the repository browser.