source: josm/trunk/README@ 6138

Last change on this file since 6138 was 5545, checked in by bastiK, 12 years ago

see #8165 - document 3rd party libs in README
  • Property svn:mime-type set to text/plain;charset=utf-8
File size: 8.2 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) 1.6, or later.
13
14
15How to get Java Runtime Environment
16-----------------------------------
17You need JRE Version 1.6 (also called Java 6), or later.
18
19Microsoft Windows users should visit http://www.java.com
20and download the latest Java executable for Windows systems.
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 - *.gsb NTv2 grid files for projection support
62 - *.lang translation data
63 - *.xsd xml schema files for validation of configuration files
64 - epsg list of projection definitions
65 - help-browser.css CSS file for the help sites (HTML content is downloaded from the website
66 on demand, but displayed inside the programm in a Java web browser component.)
67 - ignoretags.cfg, tagchecker.cfg
68 data files used by the JOSM validator feature
69- data_nodist/ data files that are useful for development, but not distributed
70 - exif-direction-example.jpg
71 sample image, that contains direction information in the EXIF header
72 (keys: Exif.GPSInfo.GPSImgDirectionRef, Exif.GPSInfo.GPSImgDirection)
73 - filterTests.osm used for unit testing of the filter feature
74 (see test/unit/org/openstreetmap/josm/data/osm/FilterTest.java)
75 - Join_Areas_Tests.osm some examples to test the 'join areas' feature
76 - mapcss/ sample map styles and corresponding data files for regression testing
77 - projection-reference-data.csv
78 reference data for projection tests
79 (see test/unit/org/openstreetmap/josm/data/projection/ProjectionRefTest.java)
80 - projection-regression-test-data.csv
81 regression data for projection tests
82 (see test/unit/org/openstreetmap/josm/data/projection/ProjectionRegressionTest.java)
83- geticons.pl tool, to find all used icons and allows deleting unused icons
84- gpl-2.0.txt, gpl-3.0.txt full text of the GNU General Public License
85- images/ images distributed with the JOSM binary
86 - icons images for the Potlatch 2 style
87 - styles/standard images for the main map style (external repository)
88- images_nodist/ images, which are not for distribution, but may be useful later (e.g. high
89 resolution and vector versions)
90- josm.jnlp Java Web Start launcher file (used on the website)
91- lib/ libraries (directory is empty at the moment)
92- LICENSE the JOSM license terms
93- macosx/ files needed to create the MacOS package
94- netbeans/ preconfigured Netbeans project
95- optimize-images short script to decrease size of PNG images
96- patches/ patches for external libraries used in JOSM (see below)
97- README this file
98- src/ the source code of the program
99- start.html HTML page to run the applet version of JOSM
100- styles/ map styles included in JOSM
101- sytles_nodist/ files needed for map style maintenance
102 - potlatch2/README infos on how to update the Potlatch 2 style from upstream sources
103- test/ automated software tests
104 - functional/ functional tests (source code)
105 - lib/ libraries needed for (some of) the tests
106 - unit/ unit tests (source code)
107- tools/ libraries and tools that help in the development process
108 - animal-sniffer-ant-tasks-1.7.jar
109 TODO: what is this?
110 - findbugs/ libs and config files for findbugs (automatically detects common bugs and potential
111 problems in source code); can be launched as an ant target in build.xml
112 - javacc.jar used in the build process to generate some .java files from a javacc source file
113 (src/org/openstreetmap/josm/gui/mappaint/mapcss/MapCSSParser.jj)
114 - proguard.jar optimize final binary jar - see build.xml (not used in production so far)
115
116The 'patches' directory
117-----------------------
118Some libraries that JOSM depends on, are patched for various reasons. The files in the patches directory can be used to roll back these customizations. This is useful in order to
119
120 * inspect the changes
121 * update to a newer version of the library but keep the modifications
122
123You can use 'quilt' to manage the patches. E.g. the following command applies all of them:
124
125 $ quilt push -a
126
127Of course, it is also possible to apply the patch files manually one by one.
128
129Third party libraries
130---------------------
131There are a couple of third party libraries which are directly included in the source code tree, in particular:
132
133* jmapviewer: Java component to browse a TMS map
134 src/org/openstreetmap/gui (svn external)
135 -> http://svn.openstreetmap.org/applications/viewer/jmapviewer/
136* Apache Ant's bzip2: Support for bzip2 compression when opening files
137 src/org/apache/tools/bzip2 (svn external)
138 -> http://svn.apache.org/repos/asf/ant/core/trunk/src/main/org/apache/tools/bzip2
139* Apache commons codec: Better Base64 support
140 src/org/apache/commons/codec (svn external)
141 -> http://svn.apache.org/repos/asf/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec
142* SVG Salamander: Support for SVG image format
143 src/com/kitfox/svg
144 -> http://svgsalamander.java.net/
145* Metadata Extractor: Read EXIF Metadata of photos
146 src/com/drew
147 -> http://www.drewnoakes.com/code/exif/
148* Signpost: OAuth library
149 src/oauth, src/com/google
150 -> http://code.google.com/p/oauth-signpost/
151* GNU getopt Java port: Command line argument processing library
152 src/gnu/getopt
153 -> http://www.urbanophile.com/~arenn/hacking/download.html
154* MultiSplitPane: Small lib for GUI layout management
155 src/org/openstreetmap/josm/gui/MultiSplitLayout.java, MultiSplitPane.java
156 -> http://today.java.net/pub/a/today/2006/03/23/multi-split-pane.html
157* swinghelper: Class CheckThreadViolationRepaintManager to find classpath violations
158 src/org/jdesktop/swinghelper/debug/CheckThreadViolationRepaintManager.java
159 -> http://java.net/projects/swinghelper
160
161
Note: See TracBrowser for help on using the repository browser.