Changeset 5545 in josm for trunk/README


Ignore:
Timestamp:
2012-10-31T23:32:13+01:00 (7 years ago)
Author:
bastiK
Message:

see #8165 - document 3rd party libs in README

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/README

    r5493 r5545  
    44            I. Install & Launch
    55=============================================================================
    6    
     6
    77Installation notes
    88------------------
     
    1010
    1111* The JOSM .jar file, e.g., josm-tested.jar or josm-latest.jar
    12 * Java Runtime Environment (JRE) 1.6, or later. 
     12* Java Runtime Environment (JRE) 1.6, or later.
    1313
    1414
    1515How to get Java Runtime Environment
    1616-----------------------------------
    17 You need JRE Version 1.6 (also called Java 6), or later. 
     17You need JRE Version 1.6 (also called Java 6), or later.
    1818
    19 Microsoft Windows users should visit http://www.java.com 
     19Microsoft Windows users should visit http://www.java.com
    2020and download the latest Java executable for Windows systems.
    2121
    2222Linux users should visit http://www.oracle.com/technetwork/java/index.html
    23 There is a Linux binary installer, which you must execute from a console, or 
     23There is a Linux binary installer, which you must execute from a console, or
    2424use the mechanism of your distribution's packaging system.
    2525
     
    3535Under Linux, open a shell, go to the file directory and type
    3636"java -jar josm-latest.jar" to launch. If this does not work, try to set
    37 your JAVA_HOME variable to the java executable location (the root location, 
     37your JAVA_HOME variable to the java executable location (the root location,
    3838not the bin).
    3939
     
    4646How to get the source code
    4747--------------------------
    48 Download it directly from the subversion at 
    49 https://josm.openstreetmap.de/svn/trunk. To use the command line subversion 
     48Download it directly from the subversion at
     49https://josm.openstreetmap.de/svn/trunk. To use the command line subversion
    5050client, type
    5151
     
    6363    - *.xsd                 xml schema files for validation of configuration files
    6464    - epsg                  list of projection definitions
    65     - help-browser.css      CSS file for the help sites (HTML content is downloaded from the website 
     65    - help-browser.css      CSS file for the help sites (HTML content is downloaded from the website
    6666                            on demand, but displayed inside the programm in a Java web browser component.)
    6767    - ignoretags.cfg, tagchecker.cfg
    6868                            data files used by the JOSM validator feature
    6969- data_nodist/              data files that are useful for development, but not distributed
    70     - exif-direction-example.jpg 
     70    - exif-direction-example.jpg
    7171                            sample image, that contains direction information in the EXIF header
    7272                            (keys: Exif.GPSInfo.GPSImgDirectionRef, Exif.GPSInfo.GPSImgDirection)
     
    7575    - Join_Areas_Tests.osm  some examples to test the 'join areas' feature
    7676    - mapcss/               sample map styles and corresponding data files for regression testing
    77     - projection-reference-data.csv               
     77    - projection-reference-data.csv
    7878                            reference data for projection tests
    7979                            (see test/unit/org/openstreetmap/josm/data/projection/ProjectionRefTest.java)
    80     - projection-regression-test-data.csv         
     80    - projection-regression-test-data.csv
    8181                            regression data for projection tests
    8282                            (see test/unit/org/openstreetmap/josm/data/projection/ProjectionRegressionTest.java)
     
    8686    - icons                 images for the Potlatch 2 style
    8787    - 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 
     88- images_nodist/            images, which are not for distribution, but may be useful later (e.g. high
    8989                            resolution and vector versions)
    9090- josm.jnlp                 Java Web Start launcher file (used on the website)
     
    118118Some 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
    119119
    120  * inspect the changes 
     120 * inspect the changes
    121121 * update to a newer version of the library but keep the modifications
    122122
    123 You can use 'quilt' to manage the patches. E.g. the following command applies all of them: 
     123You can use 'quilt' to manage the patches. E.g. the following command applies all of them:
    124124
    125125 $ quilt push -a
     
    127127Of course, it is also possible to apply the patch files manually one by one.
    128128
     129Third party libraries
     130---------------------
     131There are a couple of third party libraries which are directly included in the source code tree, in particular:
    129132
     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 TracChangeset for help on using the changeset viewer.