source: josm/trunk/README

Last change on this file was 11780, checked in by Don-vip, 4 days ago

update to error_prone 2.0.19

  • Property svn:eol-style set to native
  • Property svn:mime-type set to text/plain;charset=utf-8
File size: 9.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 X 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- data/                     data files that will be included in the JOSM jar file
61    - fonts/                font files used for map rendering
62    - projection/           projection files
63      - epsg                list of projection definitions
64    - *.lang                translation data
65    - *.xsd                 xml schema files for validation of configuration files
66    - help-browser.css      CSS file for the help sites (HTML content is downloaded from the website
67                            on demand, but displayed inside the programm in a Java web browser component.)
68    - validator/            data files used by the JOSM validator feature
69      - *.cfg               files designed for the old tagchecker, still used
70      - *.mapcss            default validation rules for the new mapcss-based tagchecker
71- data_nodist/              data files that are useful for development, but not distributed
72    - exif-direction-example.jpg
73                            sample image, that contains direction information in the EXIF header
74                            (keys: Exif.GPSInfo.GPSImgDirectionRef, Exif.GPSInfo.GPSImgDirection)
75    - filterTests.osm       used for unit testing of the filter feature
76                            (see test/unit/org/openstreetmap/josm/data/osm/FilterTest.java)
77    - Join_Areas_Tests.osm  some examples to test the 'join areas' feature
78    - mapcss/               sample map styles and corresponding data files for regression testing
79    - projection/           projection files
80      - *.gsb               NTv2 grid files for projection support (see CONTRIBUTION)
81    - projection-reference-data.csv
82                            reference data for projection tests
83                            (see test/unit/org/openstreetmap/josm/data/projection/ProjectionRefTest.java)
84    - projection-regression-test-data.csv
85                            regression data for projection tests
86                            (see test/unit/org/openstreetmap/josm/data/projection/ProjectionRegressionTest.java)
87- geticons.pl               tool to find all used icons and allows deleting unused icons
88                            searches also for images with incompatible svg code
89- gpl-2.0.txt, gpl-3.0.txt  full text of the GNU General Public License
90- images/                   images distributed with the JOSM binary
91    - icons                 images for the Potlatch 2 style
92    - presets               images for the main mappaint style and the internal presets
93- images_nodist/            images, which are not for distribution, but may be useful later (e.g. high
94                            resolution and vector versions)
95- josm.jnlp                 Java Web Start launcher file (used on the website for the tested version)
96- josm-latest.jnlp          Java Web Start launcher file (used on the website for the latest version)
97- LICENSE                   the JOSM license terms
98- linux/                    files useful for Linux distributions, including Appdata files, .desktop
99                            files, Debian/Ubuntu scripts, man pages, icons, etc.
100- macosx/                   files needed to create the MacOS X package
101- netbeans/                 preconfigured Netbeans project
102- optimize-images           short script to decrease size of PNG images
103- patches/                  patches for external libraries used in JOSM (see below)
104- README                    this file
105- resources/                resource files that will be included in the JOSM jar file
106- scripts/                  various scripts used by JOSM developers
107- src/                      the source code of the program
108- start.html                HTML page to run the applet version of JOSM
109- styles/                   map styles included in JOSM
110- sytles_nodist/            files needed for map style maintenance
111    - potlatch2/README      infos on how to update the Potlatch 2 style from upstream sources
112- test/                     automated software tests
113    - data/                 resources used for some tests
114    - functional/           functional tests (source code)
115    - lib/                  libraries needed for (some of) the tests, including JUnit
116    - performance/          performance tests (source code)
117    - unit/                 unit tests (source code)
118- tools/                    libraries and tools that help in the development process
119    - animal-sniffer-ant-tasks-1.15.jar
120                            used to build and check code signatures to ensure plugins binary compatibility
121    - appbundler-1.0ea.jar  used to build Mac OS X package
122    - checkstyle/           libs and config files for checkstyle (automatically detects code style
123                            problems in source code); can be launched as an ant target in build.xml
124    - commons-cli-1.3.1.jar dependency of Groovy Ant task
125    - error_prone_ant-2.0.19.jar
126                            used to detect code errors during compilation
127    - findbugs/             libs and config files for findbugs (automatically detects common bugs and potential
128                            problems in source code); can be launched as an ant target in build.xml
129    - groovy-all-2.4.8.jar  used for some unit tests and various scripts
130    - jacocoant.jar         used to include coverage data into JUnit test reports
131    - japicc/               used to generate a compatibility report between optimized jar and normal one
132    - javacc.jar            used in the build process to generate some .java files from a javacc source file
133                            (src/org/openstreetmap/josm/gui/mappaint/mapcss/MapCSSParser.jj)
134    - proguard.jar          optimize final binary jar - see build.xml (not used in production so far)
135    - xmltask.jar           used to edit XML files from Ant for the OSX package
136- windows/                  files needed to create the Windows installer
137
138The 'patches' directory
139-----------------------
140Some libraries that JOSM depends on, are patched for various reasons. The
141files in the patches directory can be used to roll back these customizations.
142This is useful in order to
143 * inspect the changes
144 * update to a newer version of the library but keep the modifications
145
146You can use 'quilt' to manage the patches. E.g. the following command applies all of them:
147
148 $ quilt push -a
149
150Of course, it is also possible to apply the patch files manually one by one.
151
152Third party libraries
153---------------------
154There are some third party libraries which are directly included in the source code tree, in particular:
155
156* jmapviewer: Java component to browse a TMS map
157    src/org/openstreetmap/gui (svn external)
158    -> http://svn.openstreetmap.org/applications/viewer/jmapviewer/
159* Apache commons compress: Support for bzip2 compression when opening files
160    src/org/apache/commons/compress/compressors (svn external)
161    -> https://github.com/apache/commons-compress
162* Apache commons validator: Improved validator routines
163    src/org/openstreetmap/josm/data/validation/routines
164    -> http://commons.apache.org/proper/commons-validator
165* SVG Salamander: Support for SVG image format
166    src/com/kitfox/svg
167    -> https://github.com/blackears/svgSalamander
168* Metadata Extractor: Read EXIF Metadata of photos
169    src/com/drew
170    -> https://github.com/drewnoakes/metadata-extractor
171* Signpost: OAuth library
172    src/oauth, src/com/google
173    -> https://github.com/mttkay/signpost
174* GNU getopt Java port: Command line argument processing library
175    src/gnu/getopt
176    -> https://github.com/arenn/java-getopt
177* MultiSplitPane: Small lib for GUI layout management
178    src/org/openstreetmap/josm/gui/MultiSplitLayout.java, MultiSplitPane.java
179    -> http://today.java.net/pub/a/today/2006/03/23/multi-split-pane.html
180    -> https://community.oracle.com/docs/DOC-983539
181* swinghelper: Class CheckThreadViolationRepaintManager to find classpath violations
182    src/org/jdesktop/swinghelper/debug/CheckThreadViolationRepaintManager.java
183    -> https://java.net/projects/swinghelper
Note: See TracBrowser for help on using the repository browser.