Deployed 84c7e24 with MkDocs version: 1.6.1

mwp-Gtk4-migration-guide/index.html

@@ -366,18 +366,27 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#specific-components" class="md-nav__link">
+  <a href="#supported-os" class="md-nav__link">
     <span class="md-ellipsis">
-      Specific components
+      Supported OS
     </span>
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#unsupported-os" class="md-nav__link">
+  <a href="#unsupported-but-usable-os" class="md-nav__link">
     <span class="md-ellipsis">
-      Unsupported OS
+      Unsupported but usable OS
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#specific-components" class="md-nav__link">
+    <span class="md-ellipsis">
+      Specific components
     </span>
   </a>
 
@@ -1428,18 +1437,27 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#specific-components" class="md-nav__link">
+  <a href="#supported-os" class="md-nav__link">
     <span class="md-ellipsis">
-      Specific components
+      Supported OS
     </span>
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#unsupported-os" class="md-nav__link">
+  <a href="#unsupported-but-usable-os" class="md-nav__link">
     <span class="md-ellipsis">
-      Unsupported OS
+      Unsupported but usable OS
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#specific-components" class="md-nav__link">
+    <span class="md-ellipsis">
+      Specific components
     </span>
   </a>
 
@@ -1661,17 +1679,24 @@ <h1 id="mwp-migration-guide">mwp Migration Guide<a class="headerlink" href="#mwp
 <p>This document describes the migration from legacy (Gtk+-3.0) mwp to contemporary (Gtk4) mwp.</p>
 <p><img alt="mwp" src="../images/mwp4.png" /></p>
 <h2 id="system-requirements">System Requirements<a class="headerlink" href="#system-requirements" title="Permanent link">#</a></h2>
+<h3 id="supported-os">Supported OS<a class="headerlink" href="#supported-os" title="Permanent link">#</a></h3>
 <ul>
-<li>Modern POSIX operating system, for example:<ul>
+<li>Modern Open Source POSIX operating system, for example:<ul>
 <li>Alpine Linux 3.20+</li>
 <li>Arch Linux</li>
 <li>Debian "Trixie" / "Sid" (and derivatives)</li>
 <li>Fedora 40+</li>
 <li>FreeBSD 14+</li>
-<li>MacOS (recent)</li>
+<li>Ubuntu 24.04 and later (and derivatives).</li>
 </ul>
 </li>
 </ul>
+<h3 id="unsupported-but-usable-os">Unsupported but usable OS<a class="headerlink" href="#unsupported-but-usable-os" title="Permanent link">#</a></h3>
+<ul>
+<li>MacOS (Ventura or later), requires <code>homebrew</code>. <a href="../mwp-macos/">Platform specifics</a></li>
+<li>Windows (10 or later), requires <code>MSys2</code>. <a href="../mwp-windows-msys/">Platform specifics</a></li>
+</ul>
+<p>Note that most of the documentation assumes open source OS (Linux, FreeBSD) semantics. See the "Platform Specifics" documents for differences.</p>
 <h3 id="specific-components">Specific components<a class="headerlink" href="#specific-components" title="Permanent link">#</a></h3>
 <p>The following are minimum versions.</p>
 <ul>
@@ -1685,11 +1710,6 @@ <h3 id="specific-components">Specific components<a class="headerlink" href="#spe
 <li>libsecret-1</li>
 </ul>
 <p>For replaying blackbox log, <a href="https://github.com/stronnag/bbl2kml">bbl2kml</a> 1.0.24 or later is rquired.</p>
-<h3 id="unsupported-os">Unsupported OS<a class="headerlink" href="#unsupported-os" title="Permanent link">#</a></h3>
-<ul>
-<li>MacOS (Ventura or later), requires <code>homebrew</code></li>
-<li>Windows (10 or later), requires <code>MSys2</code></li>
-</ul>
 <h2 id="gsettings-dconf-schema">GSettings /DConf schema<a class="headerlink" href="#gsettings-dconf-schema" title="Permanent link">#</a></h2>
 <p>The gsettings / dconf schema is now <code>/org/stronnag/mwp/</code>. The keys are (mainly) the same as for legacy mwp/gtk3 and may be migrated:</p>
 <div class="highlight"><pre><span></span><code>dconf dump /org/mwptools/planner/ | dconf load /org/stronnag/mwp/

mwp-macos/index.html

@@ -1340,6 +1340,7 @@ <h2 id="other-notes">Other notes<a class="headerlink" href="#other-notes" title=
 <li>If required, add the <code>MWP_MAC_FACTOR</code> environment variable to <code>~/.config/mwp/cmdopts</code></li>
 </ul>
 <p>On Ventura, the menus may behave strangely, to the point of being almost unusable. This may be mitigated by setting the environment variable <code>MWP_MAC_NO_NEST</code> (to anything).</p>
+<p><code>libsrecret</code> and other Dbus related services are not available.</p>
 
 
 

mwp-windows-msys/index.html

@@ -1631,6 +1631,10 @@ <h1>Windows (MSys2)</h1>
 
 <h2 id="overview">Overview<a class="headerlink" href="#overview" title="Permanent link">#</a></h2>
 <p><a href="https://github.com/stronnag/mwptools">mwp</a> has, since December 2024, had somewhat functional support for  building <code>mwptools</code> using the Windows <a href="https://www.msys2.org/">Msys2</a> toolchain with the aim of providing a native Windows version of mwp.</p>
+<ul>
+<li>May be built locally using the <a href="https://www.msys2.org/">Msys2</a></li>
+<li>A "portable" Windows Installer is published in the "Snapshot" builds (Github release area).</li>
+</ul>
 <h2 id="status">Status<a class="headerlink" href="#status" title="Permanent link">#</a></h2>
 <p>Somewhat experimental, however most things work.</p>
 <h2 id="building">Building<a class="headerlink" href="#building" title="Permanent link">#</a></h2>
@@ -1670,8 +1674,11 @@ <h3 id="pkgbuild">PKGBUILD<a class="headerlink" href="#pkgbuild" title="Permanen
 After you've done this once, subsequently, after the repo has been updated, you can rerun the build / package generation by rerunning <code>makepkg-mingw</code> (and <code>pacman</code> to install) as required.</li>
 </ul>
 <h3 id="windows-installer">Windows Installer<a class="headerlink" href="#windows-installer" title="Permanent link">#</a></h3>
-<p>There is also a <a href="http://seyrsnys-mwptools-win64.surge.sh/">Windows Installer</a>. At some stage this may be incorporated into the Github "Releases" page.</p>
-<p>Unzip the archive and run the installer. Select the option to install a desktop icon if you wish.</p>
+<p>Run the installer. Select the option to install a desktop icon if you wish. Options are provided for a System or Portable (user local) installation.</p>
+<ul>
+<li>If you select a portable (user local) installation, the "DejaVu Mono" fonts cannot be installed, resulting in an ugly side panel.</li>
+<li>The portable (user local) installation may be removed by deleting the installation directory.</li>
+</ul>
 <h4 id="binary-components-and-open-source-licences">Binary Components and Open Source Licences<a class="headerlink" href="#binary-components-and-open-source-licences" title="Permanent link">#</a></h4>
 <p>The Windows installer includes components distributed under various Open Source
 Licences:</p>
@@ -1720,11 +1727,11 @@ <h2 id="known-issues">Known issues<a class="headerlink" href="#known-issues" tit
 <h2 id="data-locations">Data Locations<a class="headerlink" href="#data-locations" title="Permanent link">#</a></h2>
 <h3 id="configuration-files">Configuration Files<a class="headerlink" href="#configuration-files" title="Permanent link">#</a></h3>
 <ul>
-<li><code>%UserProfile%\AppData\Local\mwp</code> / <code>$LOCALAPPDATA/mwp</code></li>
+<li><code>%UserProfile%\AppData\Local\mwp</code> / <code>$LOCALAPPDATA/mwp</code> (<code>~/.config/mwp</code> on POSIX systems).</li>
 </ul>
 <h3 id="map-caches">Map caches:<a class="headerlink" href="#map-caches" title="Permanent link">#</a></h3>
 <ul>
-<li><code>%UserProfile%\AppData\Local\Microsoft\Windows\INetCache</code> / <code>$LOCALAPPDATA/Microsoft/Windows/INetCache</code></li>
+<li><code>%UserProfile%\AppData\Local\Microsoft\Windows\INetCache</code> / <code>$LOCALAPPDATA/Microsoft/Windows/INetCache</code> (<code>~/.cache</code> on POSIX systems).</li>
 <li>And sub-directories:<ul>
 <li><code>shumate</code> : Tile caches</li>
 <li><code>mwp/DEMs</code> : Digital Elevation Models (aka Terrain data)</li>
@@ -1754,7 +1761,7 @@ <h2 id="reporting-issues">Reporting Issues<a class="headerlink" href="#reporting
 <li>Build issues require the full build text, not just some random subset</li>
 <li>Run time issues require the "stderr" log (<code>mwp_stderr_YYYY-MM_DD.txt</code>) as well as any artefacts that cause an issue (BBL, ETX log, mission files etc.).</li>
 </ul>
-<p>Until just now, these folders defaulted to GLib's <code>Environment.get_home_dir()</code> which was <code>$HOME</code> / <code>%HOME%</code> everywhere.
+<p>Previously, these folders defaulted to GLib's <code>Environment.get_home_dir()</code> which was <code>$HOME</code> / <code>%HOME%</code> everywhere.
 Now they default to:</p>
 <ul>
 <li>Normal (POSIX) OS: <code>Environment.get_home_dir()</code> aka <code>$HOME</code></li>