source: josm/trunk/README @ 8151

Last change on this file since 8151 was 8150, checked in by stoecker, 5 years ago

see #11257 - fix README

  • Property svn:eol-style set to native
  • Property svn:mime-type set to text/plain;charset=utf-8
File size: 9.3 KB
[4600]1Supplemental information for JOSM -- the Java OpenStreetMap Editor
4            I. Install & Launch
[4600]7Installation notes
[14]9To run JOSM, you need:
[4600]11* The JOSM .jar file, e.g., josm-tested.jar or josm-latest.jar
[7001]12* Java Runtime Environment (JRE) 7, or later.
[4600]15How to get Java Runtime Environment
[7001]17You need JRE Version 7, or later.
[7489]19Microsoft Windows and Apple Mac OS X users should visit
[6216]20and download the latest Java executable for their system.
[4600]22Linux users should visit
[5545]23There is a Linux binary installer, which you must execute from a console, or
[4600]24use the mechanism of your distribution's packaging system.
27How to launch
[4600]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.)
[4600]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
[5545]37your JAVA_HOME variable to the java executable location (the root location,
[4600]38not the bin).
[5493]40MacOS X users just click on the .jar file icon.
43            II. Development
[4600]46How to get the source code
[5545]48Download it directly from the subversion at
49 To use the command line subversion
[4600]50client, type
[5341]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- data/                     data files that will be included in the JOSM jar file
[7867]61    - fonts/                font files used for map rendering
62    - projection/           projection files
63      - *.gsb               NTv2 grid files for projection support
64      - epsg                list of projection definitions
[5341]65    - *.lang                translation data
66    - *.xsd                 xml schema files for validation of configuration files
[5545]67    - help-browser.css      CSS file for the help sites (HTML content is downloaded from the website
[5341]68                            on demand, but displayed inside the programm in a Java web browser component.)
[7867]69    - validator/            data files used by the JOSM validator feature
70      - *.cfg               files designed for the old tagchecker, still used
71      - *.mapcss            default validation rules for the new mapcss-based tagchecker
[5341]72- data_nodist/              data files that are useful for development, but not distributed
[5545]73    - exif-direction-example.jpg
[5341]74                            sample image, that contains direction information in the EXIF header
75                            (keys: Exif.GPSInfo.GPSImgDirectionRef, Exif.GPSInfo.GPSImgDirection)
76    - filterTests.osm       used for unit testing of the filter feature
77                            (see test/unit/org/openstreetmap/josm/data/osm/
78    - Join_Areas_Tests.osm  some examples to test the 'join areas' feature
79    - mapcss/               sample map styles and corresponding data files for regression testing
[5545]80    - projection-reference-data.csv
[5341]81                            reference data for projection tests
82                            (see test/unit/org/openstreetmap/josm/data/projection/
[5545]83    - projection-regression-test-data.csv
[5341]84                            regression data for projection tests
85                            (see test/unit/org/openstreetmap/josm/data/projection/
86-               tool, to find all used icons and allows deleting unused icons
87- gpl-2.0.txt, gpl-3.0.txt  full text of the GNU General Public License
88- images/                   images distributed with the JOSM binary
89    - icons                 images for the Potlatch 2 style
90    - styles/standard       images for the main map style (external repository)
[5545]91- images_nodist/            images, which are not for distribution, but may be useful later (e.g. high
[5341]92                            resolution and vector versions)
[7867]93- josm.jnlp                 Java Web Start launcher file (used on the website for the tested version)
94- josm-latest.jnlp          Java Web Start launcher file (used on the website for the latest version)
[5341]95- LICENSE                   the JOSM license terms
[7867]96- linux/                    files useful for Linux distributions, including Appdata files, .desktop
97                            files, Debian/Ubuntu scripts, man pages, icons, etc.
98- macosx/                   files needed to create the MacOS X package
[5341]99- netbeans/                 preconfigured Netbeans project
100- optimize-images           short script to decrease size of PNG images
101- patches/                  patches for external libraries used in JOSM (see below)
102- README                    this file
[7867]103- resources/                resource files that will be included in the JOSM jar file
104- scripts/                  various scripts used by JOSM developers
[5341]105- src/                      the source code of the program
106- start.html                HTML page to run the applet version of JOSM
107- styles/                   map styles included in JOSM
108- sytles_nodist/            files needed for map style maintenance
109    - potlatch2/README      infos on how to update the Potlatch 2 style from upstream sources
110- test/                     automated software tests
[6216]111    - data/                 resources used for some tests
[5341]112    - functional/           functional tests (source code)
113    - lib/                  libraries needed for (some of) the tests
[6216]114    - performance/          performance tests (source code)
[5341]115    - unit/                 unit tests (source code)
116- tools/                    libraries and tools that help in the development process
[7934]117    - animal-sniffer-ant-tasks-1.13.jar
118                            used to build and check code signatures to ensure plugins binary compatibility
[6216]119    - appbundler-1.0ea.jar  used to build Mac OS X package for Oracle Java 7
[5341]120    - findbugs/             libs and config files for findbugs (automatically detects common bugs and potential
121                            problems in source code); can be launched as an ant target in build.xml
[7867]122    - groovy-all-2.3.9.jar  used for some unit tests and various scripts
[6216]123    - jacocoant.jar         used to include coverage data into JUnit test reports
[5341]124    - javacc.jar            used in the build process to generate some .java files from a javacc source file
125                            (src/org/openstreetmap/josm/gui/mappaint/mapcss/MapCSSParser.jj)
126    - proguard.jar          optimize final binary jar - see build.xml (not used in production so far)
[7867]127    - xmltask.jar           used to edit XML files from Ant for the OSX package
128- windows/                  files needed to create the Windows installer
130The 'patches' directory
132Some 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
[5545]134 * inspect the changes
[5341]135 * update to a newer version of the library but keep the modifications
[5545]137You can use 'quilt' to manage the patches. E.g. the following command applies all of them:
139 $ quilt push -a
141Of course, it is also possible to apply the patch files manually one by one.
[5545]143Third party libraries
[7867]145There are some third party libraries which are directly included in the source code tree, in particular:
[5545]147* jmapviewer: Java component to browse a TMS map
148    src/org/openstreetmap/gui (svn external)
149    ->
[7867]150* Apache commons compress: Support for bzip2 compression when opening files
151    src/org/apache/commons/compress/compressors (svn external)
152    ->
[7489]153* Apache commons validator: Improved validator routines
154    src/org/openstreetmap/josm/data/validation/routines
155    ->
[5545]156* SVG Salamander: Support for SVG image format
157    src/com/kitfox/svg
[7489]158    ->
[5545]159* Metadata Extractor: Read EXIF Metadata of photos
160    src/com/drew
[7489]161    ->
[5545]162* Signpost: OAuth library
163    src/oauth, src/com/google
[7489]164    ->
[5545]165* GNU getopt Java port: Command line argument processing library
166    src/gnu/getopt
[7489]167    ->
[5545]168* MultiSplitPane: Small lib for GUI layout management
169    src/org/openstreetmap/josm/gui/,
170    ->
171* swinghelper: Class CheckThreadViolationRepaintManager to find classpath violations
172    src/org/jdesktop/swinghelper/debug/
[7489]173    ->
Note: See TracBrowser for help on using the repository browser.