Changeset 5341 in josm for trunk/README


Ignore:
Timestamp:
2012-07-14T20:23:00+02:00 (7 years ago)
Author:
bastiK
Message:

extend README

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/README

    r4600 r5341  
    11Supplemental information for JOSM -- the Java OpenStreetMap Editor
    22
    3 
     3=============================================================================
     4            I. Install & Launch
     5=============================================================================
     6   
    47Installation notes
    58------------------
     
    3841MacOS users just click on the .jar file icon.
    3942
     43=============================================================================
     44            II. Development
     45=============================================================================
    4046
    4147How to get the source code
     
    4551client, type
    4652
    47 svn co https://josm.openstreetmap.de/svn/trunk
     53svn co https://josm.openstreetmap.de/svn/trunk josm
     54
     55
     56Files & directories
     57-------------------
     58This is an overview of the files and directories in the JOSM code repository:
     59- build.xml                 ant build file (standard way to create a JOSM binary)
     60- CONTRIBUTION              list of major code contributors
     61- data/                     data files that will be included in the JOSM jar file
     62    - *.gsb                 NTv2 grid files for projection support
     63    - *.lang                translation data
     64    - *.xsd                 xml schema files for validation of configuration files
     65    - epsg                  list of projection definitions
     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    - ignoretags.cfg, tagchecker.cfg
     69                            data files used by the JOSM validator feature
     70- data_nodist/              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    - mapcss/               sample map styles and corresponding data files for regression testing
     78    - projection-reference-data.csv               
     79                            reference data for projection tests
     80                            (see test/unit/org/openstreetmap/josm/data/projection/ProjectionRefTest.java)
     81    - projection-regression-test-data.csv         
     82                            regression data for projection tests
     83                            (see test/unit/org/openstreetmap/josm/data/projection/ProjectionRegressionTest.java)
     84- geticons.pl               tool, to find all used icons and allows deleting unused icons
     85- gpl-2.0.txt, gpl-3.0.txt  full text of the GNU General Public License
     86- images/                   images distributed with the JOSM binary
     87    - icons                 images for the Potlatch 2 style
     88    - styles/standard       images for the main map style (external repository)
     89- images_nodist/            images, which are not for distribution, but may be useful later (e.g. high
     90                            resolution and vector versions)
     91- josm.jnlp                 Java Web Start launcher file (used on the website)
     92- lib/                      libraries (directory is empty at the moment)
     93- LICENSE                   the JOSM license terms
     94- macosx/                   files needed to create the MacOS package
     95- netbeans/                 preconfigured Netbeans project
     96- optimize-images           short script to decrease size of PNG images
     97- patches/                  patches for external libraries used in JOSM (see below)
     98- README                    this file
     99- src/                      the source code of the program
     100- start.html                HTML page to run the applet version of JOSM
     101- styles/                   map styles included in JOSM
     102- sytles_nodist/            files needed for map style maintenance
     103    - potlatch2/README      infos on how to update the Potlatch 2 style from upstream sources
     104- test/                     automated software tests
     105    - functional/           functional tests (source code)
     106    - lib/                  libraries needed for (some of) the tests
     107    - unit/                 unit tests (source code)
     108- tools/                    libraries and tools that help in the development process
     109    - animal-sniffer-ant-tasks-1.7.jar
     110                            TODO: what is this?
     111    - findbugs/             libs and config files for findbugs (automatically detects common bugs and potential
     112                            problems in source code); can be launched as an ant target in build.xml
     113    - javacc.jar            used in the build process to generate some .java files from a javacc source file
     114                            (src/org/openstreetmap/josm/gui/mappaint/mapcss/MapCSSParser.jj)
     115    - proguard.jar          optimize final binary jar - see build.xml (not used in production so far)
     116
     117The 'patches' directory
     118-----------------------
     119Some 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
     120
     121 * inspect the changes
     122 * update to a newer version of the library but keep the modifications
     123
     124You can use 'quilt' to manage the patches. E.g. the following command applies all of them:
     125
     126 $ quilt push -a
     127
     128Of course, it is also possible to apply the patch files manually one by one.
     129
     130
Note: See TracChangeset for help on using the changeset viewer.