Removed BOM
[GPXSee.git] / README.md
blob97bab085bbfcd332a7eb7e7e94c59d6962550ac8
1 # GPXSee
2 GPXSee is a Qt-based GPS log file viewer and analyzer that supports all common
3 GPS log file formats.
5 ## Features
6 * Opens GPX, TCX, FIT, KML, NMEA, IGC, CUP, SIGMA SLF, Suunto SML, LOC, GeoJSON,
7   OziExplorer (PLT, RTE, WPT), Garmin GPI&CSV, TomTom OV2&ITN, ONmove OMD/GHP,
8   TwoNav (TRK, RTE, WPT), GPSDump WPT and geotagged JPEG files.
9 * User-definable online maps (OpenStreetMap/Google tiles, WMTS, WMS, TMS,
10   QuadTiles).
11 * Offline maps (MBTiles, OziExplorer maps, TrekBuddy maps/atlases,
12   Garmin IMG/GMAP & JNX maps, TwoNav RMaps, GeoTIFF images, BSB charts,
13   ENC charts, KMZ maps, AlpineQuest maps, Locus/OsmAnd/RMaps SQLite maps,
14   Mapsforge vector maps, QCT maps, GEMF maps, Osmdroid SQLite maps, Orux maps,
15   ESRI World-File georeferenced images).
16 * Elevation, speed, heart rate, cadence, power, temperature and gear ratio/shifts
17   graphs.
18 * Support for DEM files (SRTM HGT).
19 * Support for multiple tracks in one view.
20 * Support for POI files.
21 * Print/export to PDF/PNG.
22 * Full-screen mode.
23 * HiDPI/Retina displays & maps support.
24 * Real-time GPS position.
25 * Windows, macOS, Linux and Android builds.
27 ![GPXSee - Linux](https://www.gpxsee.org/gallery/linux.png)
29 ## Build
30 Build requirements:
31 * Qt5 >= 5.11 or Qt6 >= 6.2 (Android builds require Qt6)
32 * C++11 or newer compiler (tested: msvc2019, gcc 7.5.0, clang/Apple LLVM version
33   10.0.0)
35 Build steps:
36 ```shell
37 lrelease gpxsee.pro
38 qmake gpxsee.pro
39 make # nmake on windows
40 ```
42 ## Download
43 * [Windows & OS X builds](https://sourceforge.net/projects/gpxsee)
44 * [Linux packages](https://software.opensuse.org/download.html?project=home%3Atumic%3AGPXSee&package=gpxsee)
45 * [Android APKs](https://play.google.com/store/apps/details?id=org.gpxsee.gpxsee)
47 ## Changelog
48 [Changelog](https://build.opensuse.org/package/view_file/home:tumic:GPXSee/gpxsee/gpxsee.changes)
50 ## Homepage
51 [https://www.gpxsee.org](https://www.gpxsee.org)
53 ## Maps
54 [GPXSee maps repository](https://github.com/tumic0/GPXSee-maps)
56 ## Translations
57 GPXSee uses [Weblate](https://hosted.weblate.org/projects/gpxsee/translations/)
58 for translations.
60 ## License
61 GPXSee is licensed under GPL-3.0 (only). However, some 3rd party parts are using
62 different, GPL compatible, licenses:
64 * [Icons8 Flat Color Icons](icons/GUI/FlatColor) - MIT
65 * [Papirus icons](icons/GUI/Papirus) - GPLv3
66 * [Mapbox Maki icons](icons/map/POI) - CC0
67 * [Map Icons Collection](icons/symbols) - CC BY SA 3.0
68 * [RTree implementation](src/common/rtree.h) - Public domain
69 * [Albers](src/map/proj/albersequal.cpp), [Geocentric](src/map/geocentric.cpp),
70   [LCC](src/map/proj/lambertconic.cpp), [Mercator](src/map/proj/mercator.cpp),
71   [Polar Stereographic](src/map/proj/polarstereographic.cpp),
72   [Polyconic](src/map/proj/polyconic.cpp) and
73   [Transverse Mercator](src/map/proj/transversemercator.cpp) projections - NIMA
74   Source Code Disclaimer
75 * [Projection parameters CSV files](data/CRS) - BSD/EPSG/Public domain
76 * [Mapsforge render theme](data/mapsforge/default.xml) and its
77   [icons](icons/map/mapsforge) - LGPLv3