Skip to content

Commit

Permalink
Deployed 380808b with MkDocs version: 1.6.1
Browse files Browse the repository at this point in the history
  • Loading branch information
stronnag committed Dec 7, 2024
1 parent 9275480 commit b0d8858
Show file tree
Hide file tree
Showing 7 changed files with 87 additions and 13 deletions.
5 changes: 3 additions & 2 deletions Building-with-meson-and-ninja/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1571,6 +1571,7 @@ <h2 id="overview">Overview<a class="headerlink" href="#overview" title="Permanen
<p>For Fedora, the is a also a documented list of packages.</p>
<p>For Arch, the <code>PKGBLD</code> lists the required packages.</p>
<p>For MacOS, use Homebrew to install required packages, having evinced the names from one of the Linux guides.</p>
<p>For Windows (MSys2), see <a href="https://github.com/stronnag/mwptools/discussions/182">Github discussion #182</a> for dependencies and workarounds).</p>
<p>For any other distribution / platform / OS, any of the above documents should give you an idea of the packages required, typically:</p>
<ul>
<li>Gtk4 (4.14)</li>
Expand Down Expand Up @@ -1676,9 +1677,9 @@ <h3 id="default">Default<a class="headerlink" href="#default" title="Permanent l
</tbody>
</table>
<h3 id="libraries">Libraries<a class="headerlink" href="#libraries" title="Permanent link">#</a></h3>
<pre><code>$prefix/lib/libmwpclib.*so.2.0.0
<pre><code>$prefix/lib/libmwpclib.*so.x.0.0
$prefix/lib/libmwpclib.a
$prefix/lib/libmwpvlib.*so.2.0.0
$prefix/lib/libmwpvlib.*so.x.0.0
$prefix/lib/libmwpclib.a
</code></pre>
<div class="admonition note">
Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1344,7 +1344,7 @@ <h3 id="log-replay-formats">Log replay formats<a class="headerlink" href="#log-r
</ul>
<p>Log replay requires tools from the <a href="https://github.com/stronnag/bbl2kml">flightlog2x</a> project.</p>
<h2 id="platforms-and-os">Platforms and OS<a class="headerlink" href="#platforms-and-os" title="Permanent link">#</a></h2>
<p>The tools are designed to be portable and as far as possible platform and architecture agnostic. The suite is developed on Arch Linux and is tested on Debian (Trixie / Sid), Alpine (Edge), Fedora (current) and FreeBSD (current release). Being able to satisfy the required dependencies is more important than the actual distro / OS / platform.</p>
<p>The tools are designed to be portable and as far as possible platform and architecture agnostic. The suite is developed on Arch Linux and is tested on Debian (Trixie / Sid), Alpine (Edge), Fedora (current) and FreeBSD (current release). Being able to satisfy the required dependencies is more important than the actual distro / OS / platform. mwptools also runs on proprietary OS such as MacOS and Windows.</p>
<h2 id="build-and-installation">Build and installation<a class="headerlink" href="#build-and-installation" title="Permanent link">#</a></h2>
<p>Build and installation is described in the following sections:</p>
<ul>
Expand Down
80 changes: 77 additions & 3 deletions mwp-Configuration/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -647,6 +647,21 @@
</span>
</a>

<nav class="md-nav" aria-label="Configuration Files">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#platform-differences" class="md-nav__link">
<span class="md-ellipsis">
Platform differences
</span>
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -1403,6 +1418,21 @@
</span>
</a>

<nav class="md-nav" aria-label="Configuration Files">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#platform-differences" class="md-nav__link">
<span class="md-ellipsis">
Platform differences
</span>
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -1657,11 +1687,30 @@ <h3 id="debug-flags">Debug flags<a class="headerlink" href="#debug-flags" title=
<td>256</td>
<td>GCS Location</td>
</tr>
<tr>
<td>512</td>
<td>Line of sight</td>
</tr>
<tr>
<td>1024</td>
<td>Radar</td>
</tr>
<tr>
<td>2048</td>
<td>Maps</td>
</tr>
</tbody>
</table>
<p>Values may be added together (so 511 means all).</p>
<p>Values may be ORd together (so 4095 means all).</p>
<h2 id="configuration-files">Configuration Files<a class="headerlink" href="#configuration-files" title="Permanent link">#</a></h2>
<p><a href="https://github.com/stronnag/mwptools">mwp</a> configuration files are stored in a standard directory <code>$HOME/.config/mwp</code>. This directory is created on first invocation if it does not exist. The following files may be found there:</p>
<p><a href="https://github.com/stronnag/mwptools">mwp</a> configuration files are stored in a standard directory <code>$HOME/.config/mwp</code>. This directory is created on first invocation if it does not exist.</p>
<h3 id="platform-differences">Platform differences<a class="headerlink" href="#platform-differences" title="Permanent link">#</a></h3>
<ul>
<li>POSIX XDG compliance : User Configuration directory (<code>$XDG_CONFIG_HOME</code>)</li>
<li>POSIX fallback : <code>$HOME/.config</code></li>
<li>Windows / Msys : <code>$LOCALAPPDATA</code> / <code>%LOCALAPPDATA%</code> / <code>$Env:LOCALAPPDATA</code></li>
</ul>
<p>The following files may be found in the <code>mwp</code> directory:</p>
<h2 id="cmdopts"><code>cmdopts</code><a class="headerlink" href="#cmdopts" title="Permanent link">#</a></h2>
<p>The file <code>cmdopts</code> contains command line options that the user wishes to apply permanently (and conveniently when run from a launcher icon rather than the command line).</p>
<p>The file contains CLI options exactly as would be issued from the terminal. Options may be on separate lines, and blank lines and line prefixed with a hash '#' are ignored. For example:</p>
Expand All @@ -1686,6 +1735,7 @@ <h2 id="map-sources">Map Sources<a class="headerlink" href="#map-sources" title=
<li>Maps for Free Relief</li>
<li>Bing Maps (no API key required, for as long as the service remains available).</li>
<li>MapBox (requires API key)</li>
<li>ESRI Clarity</li>
</ul>
<h3 id="mapbox-api-key-management">Mapbox API Key management<a class="headerlink" href="#mapbox-api-key-management" title="Permanent link">#</a></h3>
<p>In preparation for the announced removal of the Bing Maps service, <code>mwp</code> adds a <code>MapBox</code> entry where the user has acquired a <a href="https://mapbox.com/">Mapbox API key</a>.</p>
Expand Down Expand Up @@ -2161,12 +2211,36 @@ <h3 id="list-of-mwp-settings">List of mwp settings<a class="headerlink" href="#l
<td>3</td>
</tr>
<tr>
<td>p-height</td>
<td>Internal setting</td>
<td></td>
<td>720</td>
</tr>
<tr>
<td>p-is-fullscreen</td>
<td>Internal setting</td>
<td></td>
<td>false</td>
</tr>
<tr>
<td>p-is-maximised</td>
<td>Internal setting</td>
<td></td>
<td>true</td>
</tr>
<tr>
<td>p-pane-width</td>
<td>Private setting</td>
<td>Internal setting</td>
<td>Please do not change this unless you appreciate the consequences</td>
<td>0</td>
</tr>
<tr>
<td>p-width</td>
<td>Internal setting</td>
<td></td>
<td>1280</td>
</tr>
<tr>
<td>poll-timeout</td>
<td>Poll messages timeout (ms)</td>
<td>Timeout in milliseconds for telemetry poll messages. Note that timer loop has a resolution of 100ms.</td>
Expand Down
3 changes: 1 addition & 2 deletions mwp-geozones/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1473,8 +1473,7 @@

<h1 id="mwp-and-geozones">mwp and Geozones<a class="headerlink" href="#mwp-and-geozones" title="Permanent link">#</a></h1>
<h2 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permanent link">#</a></h2>
<p><a href="https://github.com/stronnag/mwptools">mwp</a> provides a UI for the Geozones function that is planned to appear in INAV 8.0.0. <a href="https://github.com/iNavFlight/inav/blob/master/docs/Geozones.md">INAV Documentation</a>.</p>
<p>The technical details for this feature are published as part of INAV 8.0.</p>
<p><a href="https://github.com/stronnag/mwptools">mwp</a> provides a UI for the Geozones function that first appeared in INAV 8.0.0. The technical details for this feature are published as part of INAV 8.0 <a href="https://github.com/iNavFlight/inav/blob/master/docs/Geozones.md">INAV Documentation</a>.</p>
<div class="admonition note">
<p class="admonition-title">Version Requirements</p>
<p>The proposed INAV 8.0 implementation of GeoZones <strong>requires</strong> <a href="https://github.com/stronnag/mwptools">mwp</a> 24.11.14 or later.</p>
Expand Down
8 changes: 4 additions & 4 deletions running/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1387,20 +1387,20 @@ <h2 id="command-line-options">Command line options<a class="headerlink" href="#c
--help-gapplication Show GApplication options

Application Options:
-a, --auto-connect auto-connect to first device (sets auto flag)
-a, --auto-connect Legacy, ignored)
--build-id show build id
--centre=position Centre position (lat lon or named place)
-H, --centre-on-home Centre on home
--cli-file CLI file
--cli-file CLI File
-c, --connect connect to first device (does not set auto flag)
--debug-flags Debug flags (mask)
-d, --device=device-name Serial device
--dont-maximise don&#39;t maximise the window
--dont-maximise Legacy, ignored
--force-mag force mag for vehicle direction
-t, --force-type=type-code_no Model type
-4, --force4 Force ipv4
--forward-to=device-name forward telemetry to
--full-screen open full screen
--full-screen Legacy, ignored
-k, --kmlfile=file-name KML file
-m, --mission=file-name Mission file
-M, --mod-points=N Modulo points to show in GPS trail
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

Binary file modified sitemap.xml.gz
Binary file not shown.

0 comments on commit b0d8858

Please sign in to comment.