1
0
mirror of https://github.com/tumic0/GPXSee.git synced 2025-07-17 12:24:24 +02:00

Documentation update

This commit is contained in:
2025-07-13 15:36:22 +02:00
parent 79eebd5c3e
commit 3faf6dd6ec
2 changed files with 36 additions and 26 deletions

View File

@ -48,7 +48,7 @@
<td class="os">Linux:</td> <td class="os">Linux:</td>
<td class="file">/usr/share/gpxsee/</td> <td class="file">/usr/share/gpxsee/</td>
</tr><tr> </tr><tr>
<td class="os">OS X:</td> <td class="os">Mac:</td>
<td class="file">/Applications/GPXSee.app/Contents/Resources/</td> <td class="file">/Applications/GPXSee.app/Contents/Resources/</td>
</tr><tr> </tr><tr>
<td class="os">Android<sup><a href="#androidGlobalConfig">1</a></sup>:</td> <td class="os">Android<sup><a href="#androidGlobalConfig">1</a></sup>:</td>
@ -67,7 +67,7 @@
<td class="os">Linux:</td> <td class="os">Linux:</td>
<td class="file">~/.local/share/gpxsee/</td> <td class="file">~/.local/share/gpxsee/</td>
</tr><tr> </tr><tr>
<td class="os">OS X:</td> <td class="os">Mac:</td>
<td class="file">~/Library/Application Support/GPXSee/</td> <td class="file">~/Library/Application Support/GPXSee/</td>
</tr><tr> </tr><tr>
<td class="os">Android:</td> <td class="os">Android:</td>
@ -423,7 +423,7 @@ $ gpxsee 'geo:323482,4306480;crs=EPSG:32618'
<a href="https://doc.qt.io/qt-5/qtpositioning-plugins.html">documentation</a> <a href="https://doc.qt.io/qt-5/qtpositioning-plugins.html">documentation</a>
for more info.</p> for more info.</p>
<h3 id="positioning_winmac">Windows &amp; OS X</h3> <h3 id="positioning_winmac">Windows &amp; Mac</h3>
<p>If your device/OS supports the platform positioning API (Core Location <p>If your device/OS supports the platform positioning API (Core Location
/ Windows.Devices.Geolocation) you may try that first. If you have an external / Windows.Devices.Geolocation) you may try that first. If you have an external
USB/serial GPS device connected, you can use the <code>serialnmea</code> plugin. USB/serial GPS device connected, you can use the <code>serialnmea</code> plugin.
@ -449,6 +449,27 @@ $ gpxsee 'geo:323482,4306480;crs=EPSG:32618'
<h2 id="issues">Known issues</h2> <h2 id="issues">Known issues</h2>
<h3>Code signing</h3>
<p>Due to lack of project funding GPXSee uses self-signed certificates for code signing on
Windows and Mac. Even though you will see messages from your OS that are designed to scare
you as much as possible, in reality this does not pose any security problem (you can check
the certificate issuer yourself in the git repository instead of trusting the bureaucratic
process of a corporation like Apple or DigiCert).</p>
<p>If you want a "clean user experience" like with the commercial certificates, you have
to:</p>
<h4>Windows</h4>
<p>Import the <a href="https://github.com/tumic0/GPXSee/blob/master/cert/win/gpxsee.cer">
certificate</a> into the Local Machine certificate store.</p>
<h4>Mac</h4>
<p>Modify gatekeeper rules using spctl:</p>
<pre>
sudo spctl --add --type execute --label 'GPXSee' --requirement \
'certificate leaf H"F45CCC1FF42FDF031C949BD8DC47412E8D3826D8"'
</pre>
<h3>Android file system</h3> <h3>Android file system</h3>
<p>Due to the limited file system access on Android, all map formats that consist of <p>Due to the limited file system access on Android, all map formats that consist of
multiple files (eg. OziExplorer maps or World-file georeferenced images) will not load multiple files (eg. OziExplorer maps or World-file georeferenced images) will not load
@ -469,10 +490,6 @@ $ gpxsee 'geo:323482,4306480;crs=EPSG:32618'
significantly speed up rendering of big data sets. You may enable OpenGL in significantly speed up rendering of big data sets. You may enable OpenGL in
the preferences, but be prepared that "strange things" may happen...</p> the preferences, but be prepared that "strange things" may happen...</p>
<h3>Qt6</h3>
<p>Many Linux distributions compile GPXSee using Qt6, but Qt6 has serious rendering issues
that affect GPXSee. See the following Qt bugs list for details.</p>
<h3>Qt bugs</h3> <h3>Qt bugs</h3>
<p>This is the list of the most severe Qt bugs that affect GPXSee (some of them are <p>This is the list of the most severe Qt bugs that affect GPXSee (some of them are
platform/Qt version specific):</p> platform/Qt version specific):</p>
@ -541,7 +558,7 @@ $ gpxsee 'geo:323482,4306480;crs=EPSG:32618'
<div class="h5l"><a href="#dem_downloads">DEM downloads</a></div> <div class="h5l"><a href="#dem_downloads">DEM downloads</a></div>
<div class="h5l"><a href="#hillshading">Hillshading</a></div> <div class="h5l"><a href="#hillshading">Hillshading</a></div>
<div class="h4l"><a href="#positioning">Positioning</a></div> <div class="h4l"><a href="#positioning">Positioning</a></div>
<div class="h5l"><a href="#positioning_winmac">Windows &amp; OS X</a></div> <div class="h5l"><a href="#positioning_winmac">Windows &amp; Mac</a></div>
<div class="h5l"><a href="#positioning_linux">Linux</a></div> <div class="h5l"><a href="#positioning_linux">Linux</a></div>
<div class="h4l"><a href="#issues">Known issues</a></div> <div class="h4l"><a href="#issues">Known issues</a></div>
</div> </div>

View File

@ -109,7 +109,7 @@
<li>HiDPI/Retina displays and maps support.</li> <li>HiDPI/Retina displays and maps support.</li>
<li>Real-time GPS position.</li> <li>Real-time GPS position.</li>
<li>Available for Windows, macOS, Linux and Android.</li> <li>Available for Windows, macOS, Linux and Android.</li>
<li><b>Free software</b> (GPLv3 open-source license).</li> <li>Free software (GPLv3 open-source license).</li>
</ul> </ul>
<p>GPXSee is designed as a small (no dependencies except of Qt), fast <p>GPXSee is designed as a small (no dependencies except of Qt), fast
@ -121,7 +121,7 @@
<ul id="download"> <ul id="download">
<li><a href="https://sourceforge.net/projects/gpxsee/files/Windows/">Windows installer</a></li> <li><a href="https://sourceforge.net/projects/gpxsee/files/Windows/">Windows installer</a></li>
<li><a href="https://sourceforge.net/projects/gpxsee/files/Mac%20OS%20X/">Mac OS X bundle</a></li> <li><a href="https://sourceforge.net/projects/gpxsee/files/Mac%20OS%20X/">Mac application bundle</a></li>
<li><a href="https://software.opensuse.org/download.html?project=home%3Atumic%3AGPXSee&amp;package=gpxsee"> <li><a href="https://software.opensuse.org/download.html?project=home%3Atumic%3AGPXSee&amp;package=gpxsee">
Linux repos/packages</a></li> Linux repos/packages</a></li>
<li><a href="https://play.google.com/store/apps/details?id=org.gpxsee.gpxsee">Android app (Google Play)</a> <li><a href="https://play.google.com/store/apps/details?id=org.gpxsee.gpxsee">Android app (Google Play)</a>
@ -129,32 +129,25 @@
</ul> </ul>
<p>Additionally to the source codes, GPXSee is available as a Windows <p>Additionally to the source codes, GPXSee is available as a Windows
installer and an OS X dmg from the project's Sourceforge page and in installer and a Mac dmg from the project's Sourceforge page and in
form of various Linux packages from the project's openSUSE Build Service form of various Linux packages from the project's openSUSE Build Service
page. Most Linux distributions (Archlinux, Fedora, Gentoo, openSUSE, ...) page. Most Linux distributions (Archlinux, Fedora, Gentoo, openSUSE, ...)
as well as BSD distributions (FreeBSD, NetBSD, OpenBSD) also provide as well as BSD distributions (FreeBSD, NetBSD, OpenBSD) also provide
GPXSee in their official repositories, however not always in the latest GPXSee in their official repositories, however not always in the latest
version. On OS X you can also use the MacPorts or Homebrew packaging systems version. On Mac you can also use the MacPorts or Homebrew packaging systems
to install GPXSee and on Windows you can use the Windows Package Manager to install GPXSee and on Windows you can use the Windows Package Manager
(winget).</p> (winget).</p>
<p>On Android, you can install GPXSee from the Google Play app store.</p> <p>On Android, you can install GPXSee from the Google Play app store.</p>
<p><i>The official Windows &amp; OS X installers are always signed using <p><b>The official Windows and Mac installers are always signed using
<a href="https://github.com/tumic0/GPXSee/tree/master/cert">certificates</a> <a href="https://github.com/tumic0/GPXSee/tree/master/cert">certificates</a>
available at the GitHub project page. As the certificates are non-commercial available at the GitHub project page. Due to lack of project funding the
(self-signed) you have to import the certificate on Windows first if you want certificates are non-commercial (self-signed) and you have to import the
your OS automatically check the installer when installing GPXSee. On OS X, certificate (on Windows) or modify gatekeeper rules (on Mac) first if you
Apple does not allow software that does not generate them profit like GPXSee want your OS automatically check/accept the installer. Recent versions of
to pass OS X's Gatekeeper (you can't import custom certificates) so <b>on Mac macOS will even not allow you to run the program at all until you fiddle
you need to run the application using the "right click menu" when opening it with gatekeeper!</b></p>
for the first time.</b></i></p>
<p><i><b>If you have a M1/M2 Mac, it is strongly recommended that you use
the Macports package</b> instead of the dmg from Sourceforge (or the Homebrew
package which is based on the dmg). The Macports packages provide native
ARM64 binaries while the dmg is x86_64-only and requires emulation on
M1/M2 Macs.</i></p>
<h2 id="maps">GPXSee maps</h2> <h2 id="maps">GPXSee maps</h2>