]> gitweb.fperrin.net Git - GpsPrune.git/blob - tim/prune/readme.txt
780ecc0fd04d300a3ace77e504829d476b52ed88
[GpsPrune.git] / tim / prune / readme.txt
1 GpsPrune version 19
2 ===================
3
4 GpsPrune is an application for viewing, editing and managing coordinate data from GPS systems,
5 including format conversion, charting, 3d visualisation, audio and photo correlation, and online resource lookup.
6 Full details can be found at https://gpsprune.activityworkshop.net/
7
8 GpsPrune is copyright 2006-2018 activityworkshop.net and distributed under the terms of the Gnu GPL version 2.
9 You may freely use the software, and may help others to freely use it too.  For further information
10 on your rights and how they are protected, see the included license.txt file.
11
12 GpsPrune comes without warranty and without guarantee - the authors cannot be held responsible
13 for losses incurred through use of the program, however caused.
14
15
16 Running
17 =======
18
19 To run GpsPrune from the jar file, simply call it from a command prompt or shell:
20    java -jar gpsprune_19.jar
21
22 If the jar file is saved in a different directory, you will need to include the path.
23 Depending on your system settings, you may be able to click or double-click on the jar file
24 in a file manager window to execute it.  A shortcut, menu item, alias, desktop icon
25 or other link can of course be made should you wish.
26
27 To specify a language other than the default, use an additional parameter, eg:
28    java -jar gpsprune_19.jar --lang=DE
29
30
31 New with version 19
32 ===================
33 The following fixes and additions were made since version 18:
34   - Fix for duration rounding bug affecting sub-second timestamps
35   - Wikipedia search now also includes galleries from wikimedia
36   - Photo popup window now gets updated when the track selection changes
37   - Remove export to SVG function as it has fallen behind the java3d and pov options
38   - Remove Turkish language because there haven't been any translators since early 2010
39   - Function to add waypoints along the track at intervals of distance or time (eg every 5 km)
40   - Optionally draw arrows on the track lines to show direction of travel
41   - Waypoint rendering using icons (wishlist 71)
42   - Allow user to select timezone in which timestamps are displayed (wishlist 61)
43   - Provide call to geonames.org's OSM node search function, to find amenities (like bus stops) close to the current point
44   - Fix OSM download function using overpass API
45   - Fix opencyclemap URLs
46   - Fix reading of Exif data for some unusual cases (from Adobe Lightroom?)
47   - Remove Panoramio
48   - Update wikimedia catalogue
49   - Debian and Ubuntu packages no longer rely on external libmetadata jar
50
51 New with version 18
52 ===================
53 The following features were added since version 17:
54   - New search options using opencaching.de and mapillary
55   - New web options using peakfinder, geohack and panoramio
56   - Autoplay function for automatically scrolling through the track
57   - Marking uphill lift sections of skiing / snowboarding tracks
58   - Configurable anti-aliasing for map view and profile view
59   - Allow showing just the lines between track points but not the track points
60
61 New with version 17
62 ===================
63 The following features were added since version 16:
64   - Colouring the track points according to various criteria (such as altitude,
65     speed, segment, file) in both the regular map view and the image export
66   - Marking points for deletion according to their date
67   - Select the current segment
68   - Adding an altitude tolerance to the climb and descent calculations
69   - Sorting waypoints by name or by timestamp
70
71 New with version 16
72 ===================
73 The following features were added since version 15:
74   - Extend povray output using terrain and/or map image
75   - Extend java3d output using terrain and/or map image
76   - Weather forecasts
77   - Splitting a track into segments based on distance or time
78   - Sewing track segments together
79   - Function to download and save SRTM tiles
80
81 New with version 15
82 ===================
83 The following features were added since version 14:
84   - Extend povray output using map image on base plane
85   - Export an image of the map and track at a selected zoom level
86   - Estimation of hiking times and learning of parameter values
87   - Allow altitude / speed profile to show any arbitrary field
88   - Accept files dragged and dropped onto the GpsPrune window
89   - Take account of timezone if present in track timestamps
90   - Allow timestamp exports in KML using gx extensions
91   - GPSBabel filters
92   - Improved wikipedia name lookup
93   - Allow loading of speeds and vertical speeds from text files
94
95 New with version 14
96 ===================
97 The following features were added since version 13:
98   - Dragging of existing points
99   - Creation of new points by dragging the halfway point between two points
100   - Nautical miles option including knots
101   - Full range details dialog
102   - Extension of interpolation function
103   - Selecting points within a rectangle to delete
104
105 New with version 13
106 ===================
107 The following features were added since version 12:
108   - Name change from Prune to GpsPrune
109   - Handling of description field for waypoints
110   - Opening of images from within kmz files, zip files and from http links
111   - Compression using Douglas-Peucker algorithm
112   - Option to save settings automatically on exit
113   - Dialog to show the local tile cache, report sizes and allow deletion
114     of tiles, either deleting whole tilesets or individual tiles older than
115     a specified number of days
116   - Checkbox on GPX export to specify UTF-8 rather than default system encoding
117   - Importing of files through GPSBabel
118   - List of recently used files in the menu
119   - Display of bearing at which a photo was taken (display only)
120   - Allow edit of custom map sources
121   - Russian translation
122
123 New with version 12
124 ===================
125 The following features were added since version 11:
126   - Options to load audio files, play them, connect to points and auto-correlate them
127   - Extend Gpx export to include links to photos and audio files
128   - Extend Gpx load to also load referenced photos, audio files
129   - Function to search for places in Wikipedia by name
130   - Function to search for places in Wikipedia near the current point
131   - Function to download OSM data using the XAPI and save to osm file
132   - New drawing mode to add points with one click each
133   - Hungarian translations thanks to György
134   - Korean translations thanks to HooAU
135
136 New with version 11
137 ===================
138 The following features were added since version 10:
139   - Option to select which of the named tracks to load out of a gpx file or gps
140   - Function to delete all values of a single field (eg all altitudes, all timestamps)
141   - Export of 3d view to svg file
142   - Function to upload current track to gpsies.com
143   - Option to hide sidebars (left panel, right panel and lower panel) to just show map
144   - Various bugfixes, especially with gpx export, track compression and scale bar
145   - Dutch and Czech translations thanks to generous volunteers
146
147 New with version 10
148 ===================
149 The following features were added since version 9:
150   - Function to lookup altitudes using SRTM data from the Space Shuttle
151   - Choice between altitude profile and speed profile in main view
152   - Caching of map tiles to disk for faster access
153   - Offline mode where maps are only retrieved from disk
154   - Storage of multiple custom map sources, not just one custom one
155   - Use of maps with multiple layers (like maps-for-free)
156   - Use of cloudmade maps
157
158 New with version 9
159 ==================
160 The following features were added since version 8:
161   - Ability to paste coordinates (eg from wikipedia or geocaching sites) to create new points
162   - Configurable colour settings
163   - Function to convert waypoint names into timestamps
164   - Function to reorganise and sort photos either by filename or time
165   - Ability to load gzipped xml files
166   - New "full range details" dialog including pace and average gradient
167   - Preservation of unrecognised gpx tags by copying source xml
168   - Improved photo handling and ability to rotate photos
169   - Japanese, Portuguese and Turkish languages thanks to generous user input
170
171 New with version 8
172 ==================
173 The following features were added since version 7:
174   - Loading of NMEA files (with suffix .nmea)
175   - Loading of nearby tracks from gpsies.com
176   - Function for finding waypoints by name
177   - Language-sensitive keyboard shortcuts
178   - Scale bar
179   - Display of pace (time per km or time per mile)
180   - Ability to display and save configuration settings
181   - Configurable program paths and KMZ image sizes
182   - Chinese language thanks to generous user input
183
184 New with version 7
185 ==================
186 The following features were added since version 6:
187   - Loading of KMZ files and zipped GPX
188   - Improved compression functions with four configurable algorithms
189   - New function to call gpsbabel to send data directly to GPS receiver
190   - Charting functions (eg altitude or speed against distance) using gnuplot
191   - Map view can now use other OpenStreetMap images such as OpenCycleMap or any other tile server
192   - New function to create an average position from a track section
193   - Display of straight line distances between waypoints
194
195 New with version 6
196 ==================
197 The following features were added since version 5:
198   - Map view using OpenStreetMap images is now integrated in the main window, with control for map transparency
199   - Pov export has new option to use sphere sweeps for better appearance
200   - New function to check online for a newer version of Prune
201   - New function to take a section of track and cut/paste it to another position
202   - New function to add or subtract a time offset from point timestamps
203   - New function to call gpsbabel to load data directly from GPS receiver
204   - Additional file filter options on load and save
205   - Italian language thanks to generous user input
206
207 New with version 5
208 ==================
209 The following features were added since version 4:
210   - New map window in the View menu, showing points overlaid on OpenStreetMap images
211   - New function to launch a browser showing the area in either Google Maps or OpenStreetMap
212   - Handling of track segments, including loading, saving and exporting, and preservation during edits and undos
213   - New function to merge track segments for the current selection, to make one single segment
214   - Display of current and average speed on details panel
215   - Statusbar showing confirmation of actions
216   - Much improved French texts thanks to generous user input
217
218 New with version 4
219 ==================
220 The following features were added since version 3:
221   - Automatic correlation of photos with points based on timestamps
222   - Manual disconnection of photos from points
223   - Reading of photo thumbnails from exif data (speeds up photo loading)
224   - Export to GPX format
225   - KML and KMZ export now includes altitudes option for airborne tracks
226   - Track points in map can be connected by lines
227   - On loading a text file, fields are now guessed according to data or column headings
228   - Polish language
229
230 New with version 3
231 ==================
232 The following features were added since version 2:
233   - Loading of GPX and KML files
234   - Loading of jpeg photos with or without coordinate data
235   - Manual correlation of photos with points
236   - Saving of coordinates in exif data of jpegs
237   - Exporting to KMZ format including thumbnails of photos
238   - Four-panel layout with toolbar
239   - French language
240
241 New with version 2
242 ==================
243 The following features were added since version 1:
244   - Display of data in 3d view using Java3D library
245   - Export of 3d model to POV format for rendering by povray
246   - Point edit dialog, waypoint name edit dialog
247   - Waypoint list
248   - Spanish language
249
250 Features of version 1
251 =====================
252 The following features were included in version 1:
253   - Loading of text files, display in overhead and profile views
254   - Display of track details such as distances, speeds
255   - Deletion of points and ranges, and variable compression
256   - Export to KML format
257   - English, German and Swiss German languages
258
259
260 Further information and updates
261 ===============================
262
263 To obtain the source code (if it wasn't included in your jar file), or for further information,
264 please visit the website:  http://gpsprune.activityworkshop.net/
265
266 You will find there user guides, screenshots and demo videos illustrating the major features.
267 As GpsPrune is further developed, subsequent versions of the program will also be made freely
268 available at this website.
269
270 You can also provide feedback on GpsPrune, and find out more about contributing to the development,
271 especially with regard to language translations.