source: josm/trunk/README @ 18070

Last change on this file since 18070 was 18070, checked in by Don-vip, 19 months ago

fix #16868 - use DevCharly's version of svgSalamander from Maven Central

  • Property svn:eol-style set to native
  • Property svn:mime-type set to text/plain;charset=utf-8
File size: 10.9 KB
Line 
1Supplemental information for JOSM -- the Java OpenStreetMap Editor
2
3=============================================================================
4            I. Install & Launch
5=============================================================================
6
7Installation notes
8------------------
9To run JOSM, you need:
10
11* The JOSM .jar file, e.g., josm-tested.jar or josm-latest.jar
12* Java Runtime Environment (JRE) 8, or later.
13
14
15How to get Java Runtime Environment
16-----------------------------------
17You need JRE Version 8, or later.
18
19Microsoft Windows and Apple Mac OS X users should visit https://www.java.com
20and download the latest Java executable for their system.
21
22Linux users should visit http://www.oracle.com/technetwork/java/index.html
23There is a Linux binary installer, which you must execute from a console, or
24use the mechanism of your distribution's packaging system.
25
26
27How to launch
28-------------
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.)
34
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).
39
40macOS users just click on the .jar file icon.
41
42=============================================================================
43            II. Development
44=============================================================================
45
46How to get the source code
47--------------------------
48Download it directly from the subversion at
49https://josm.openstreetmap.de/svn/trunk. To use the command line subversion
50client, type
51
52svn co https://josm.openstreetmap.de/svn/trunk josm
53
54
55Files & directories
56-------------------
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- LICENSE                   the JOSM license terms
62- native/                   OS-specific files
63  - linux/                  files useful for Linux distributions, including Appdata files, .desktop
64                            files, Debian/Ubuntu scripts, man pages, icons, etc.
65  - macosx/                 files needed to create the MacOS package
66  - windows/                files needed to create the Windows installer
67  - josm.jnlp               Java Web Start launcher file (used on the website for the tested version)
68  - josm-latest.jnlp        Java Web Start launcher file (used on the website for the latest version)
69- nodist/                   files not included in JOSM binary
70  - data/                   data files that are useful for development, but not distributed
71    - exif-direction-example.jpg
72                            sample image, that contains direction information in the EXIF header
73                            (keys: Exif.GPSInfo.GPSImgDirectionRef, Exif.GPSInfo.GPSImgDirection)
74    - filterTests.osm       used for unit testing of the filter feature
75                            (see test/unit/org/openstreetmap/josm/data/osm/FilterTest.java)
76    - Join_Areas_Tests.osm  some examples to test the 'join areas' feature
77    - *.*                   various other data files used for unit testing and as reference file
78    - projection/           projection files
79      - *.gsb               NTv2 grid files for projection support, downloaded by the
80                            client on demand (see CONTRIBUTION)
81      - CHENyx06-Distribution.pdf
82                            archive of terms of use for the CHENyx06.gsb file
83      - epsg                EPSG data file, taken from the proj.4 project
84                            (see https://github.com/OSGeo/proj.4/blob/master/nad/epsg)
85      - esri                ESRI data file, taken from the proj.4 project
86                            (see https://github.com/OSGeo/proj.4/blob/master/nad/esri)
87      - josm-epsg           customizations to the epsg file, used together with the epsg file
88                            to generate data/projection/custom-epsg
89                           
90      - projection-reference-data.csv
91                            reference data for projection tests
92                            (see test/unit/org/openstreetmap/josm/data/projection/ProjectionRefTest.java)
93      - projection-regression-test-data.csv
94                            regression data for projection tests
95                            (see test/unit/org/openstreetmap/josm/data/projection/ProjectionRegressionTest.java)
96    - trans/*.lang          translation data for files that are not distributed, but used
97                            by the server for localization of the services;
98                            currently contains plugin descriptions in order to include translations
99                            in the downloaded plugin list
100  - images/                 images, which are not for distribution, but may be useful later (e.g. high
101                            resolution and vector versions)
102  - styles/                 files needed for map style maintenance
103    - potlatch2/README      infos on how to update the Potlatch 2 style from upstream sources
104- README                    this file
105- resources/                resource files that will be included in the JOSM jar file
106  - data/                   data files that will be included in the JOSM jar file
107    - fonts/                font files used for map rendering
108    - gpx/                  different color gradients for gpx drawing
109    - projection/           projection files
110      - custom-epsg         list of projection definitions, auto-generated file created by ant task 'epsg'
111    - security/*.pem        certificates that we like to accept for TLS connections, but are missing in the
112                            default Java certificate store
113    - validator/            data files used by the JOSM validator
114      - *.cfg               files designed for the old tagchecker, still in use
115      - *.mapcss            default validation rules for the MapCSS-based tagchecker
116    - boundaries.osm        OSM file containing boundary data for the states of the earth, including
117                            data for right and left-hand traffic
118    - defaultpresets.xml    data file for the core tagging presets
119    - help-browser.css      CSS file for the help sites (HTML content is downloaded from the website
120                            on demand, but displayed inside the programm in a Java web browser component.)
121    - *.lang                translation data
122    - *.xsd                 xml schema files for validation of configuration files
123  - images/                 images distributed with the JOSM binary
124    - icons                 images for the Potlatch 2 style
125    - presets               images for the main mappaint style and the internal presets
126  - styles/                 map styles included in JOSM
127- scripts/                  various scripts used by JOSM developers
128  - BuildProjectionDefinitions.java
129                            called from the ant build file to combine the files epsg and josm-epsg
130                            to create the custom-epsg file for distribution
131  - geticons.pl             tool to find all used icons and allows deleting unused icons
132                            searches also for images with incompatible svg code
133  - optimize-images         short script to decrease size of PNG images
134  - since_xxx.py            developer tool to replace "@since xxx" in Javadoc by the upcoming revision number
135  - SyncEditorLayerIndex.java
136                            script to compare and analyse the differences of the editor layer index and the
137                            JOSM imagery list (see https://josm.openstreetmap.de/wiki/ImageryCompare)
138  - TagInfoExtract.java     extracts tag information for the taginfo project
139- src/                      the source code of the application
140- start.html                HTML page to run the applet version of JOSM
141- test/                     automated software tests
142    - data/                 resources used for some tests
143    - functional/           functional tests (source code)
144    - lib/                  libraries needed for (some of) the tests, including JUnit
145    - performance/          performance tests (source code)
146    - unit/                 unit tests (source code)
147- tools/                    libraries, tools and configuration files that help in the development process
148    - checkstyle/           libs and config files for checkstyle (automatically detects code style
149                            problems in source code); can be launched as an ant target in build.xml
150    - eclipse/              preconfigured Eclipse configuration files
151    - ivy/                  Apache Ivy binary, configuration file, and downloaded dependencies
152    - jacocoant.jar         used to include coverage data into JUnit test reports
153    - japicc/               used to generate a compatibility report between optimized jar and normal one
154    - netbeans/             preconfigured Netbeans project
155    - pmd/                  config files for PMD (source code analyzer, finds common programming flaws)
156    - spotbugs/             libs and config files for spotbugs (automatically detects common bugs and potential
157                            problems in source code); can be launched as an ant target in build.xml
158
159Third party libraries
160---------------------
161There are some third party libraries which are directly included in the source code tree, in particular:
162
163* jmapviewer: Java component to browse a TMS map
164    src/org/openstreetmap/gui (svn external)
165    -> https://josm.openstreetmap.de/osmsvn/applications/viewer/jmapviewer/
166* Apache commons compress: Support for bzip2 compression when opening files
167    -> https://github.com/apache/commons-compress
168* Apache commons validator: Improved validator routines
169    src/org/openstreetmap/josm/data/validation/routines
170    -> http://commons.apache.org/proper/commons-validator
171* SVG Salamander: Support for SVG image format
172    -> https://github.com/blackears/svgSalamander
173* Metadata Extractor: Read EXIF Metadata of photos
174    -> https://github.com/drewnoakes/metadata-extractor
175* Signpost: OAuth library
176    -> https://github.com/mttkay/signpost
177* MultiSplitPane: Small lib for GUI layout management
178    src/org/openstreetmap/josm/gui/MultiSplitLayout.java, MultiSplitPane.java
179    -> https://github.com/floscher/multi-split
180    -> https://community.oracle.com/docs/DOC-983539
181* swinghelper: Class CheckThreadViolationRepaintManager to find EDT violations
182    src/org/openstreetmap/josm/gui/util/CheckThreadViolationRepaintManager.java
183    -> https://github.com/floscher/swinghelper
184* xz extractor
185    -> https://tukaani.org/xz/java.html
186* OpeningHoursParser (MIT license)
187    -> https://github.com/simonpoole/OpeningHoursParser
Note: See TracBrowser for help on using the repository browser.