<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>extras/README.md - fork/mons @ fixes</title>
<meta name="description" content="extras/README.md in fork/mons at fixes.">
<meta property="og:title" content="extras/README.md - fork/mons @ fixes">
<meta property="og:description" content="extras/README.md in fork/mons at fixes.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="fixes" data-tip="b1e6f1688035330974b9bd006665f7a716dfbda4">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/mons</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/mons</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">coloursofnoise</span><span class="commit-message" data-commit="e5913d8dcdc915254d342dccdd84824fc370c39b">Document building and installing manual pages</span><span class="snapshot-sha sha" data-commit="e5913d8dcdc915254d342dccdd84824fc370c39b">e5913d8</span><time datetime="2023-08-28T15:32:26-07:00" title="2023-08-28 15:32:26 -0700">2023-08-28</time></p>
<header class="topbar"><details class="switcher"><summary>fixes</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/mons/ref/fixes/">fixes</a><a href="/fork/mons/ref/main/">main</a><a href="/fork/mons/ref/misc-fixes/">misc-fixes</a><a class="all" href="/fork/mons/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/mons/">mons</a> / <a href="/fork/mons/ref/fixes/tree/extras/">extras</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>785 B</span><span>27 lines</span></span><span class="actions"><a class="raw" href="/fork/mons/raw/6af2df08d1d723c69aa01f10f8ecf8a5c22a2a77/extras/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1><code>everest:</code> URI Scheme Registration</h1>
<p><img src="https://media.discordapp.net/attachments/850184494220312646/1029860061406838834/unknown.png" alt="Everest 1-Click Install button on GameBanana" /></p>
<h2>Linux</h2>
<pre class="language-bash"><a-o>$</a-o><a-f> </a-f><a-pr>cp</a-pr> mons.desktop ~/.local/share/applications/mons.desktop
<a-o>$</a-o><a-f> </a-f><a-pr>xdg</a-pr><a-f>-mime</a-f> default ~/.local/share/applications/mons.desktop <a-s>&quot;x-scheme-handler/everest&quot;</a-s>
<a-o>$</a-o><a-f> </a-f><a-pr>update</a-pr><a-f>-desktop-database</a-f> ~/.local/share/applications</pre>
<h1>Manual Pages</h1>
<h2>Build</h2>
<blockquote>
<p>[!NOTE]
Pre-built man pages are distributed with the <code>mons</code> package within <code>mons/man/</code>.</p>
</blockquote>
<pre class="language-bash"><a-o>$</a-o><a-f> #</a-f> run commands in project root
<a-o>$</a-o><a-f> </a-f><a-pr>pip</a-pr> install <a-co>-r</a-co> requirements-dev.txt
<a-o>$</a-o><a-f> </a-f><a-pr>sphinx</a-pr><a-f>-build</a-f> <a-co>-b</a-co> man docs mons/man <a-co>-d</a-co> docs/_build</pre>
<h2>Install</h2>
<h3>Linux</h3>
<pre class="language-bash"><a-o>$</a-o><a-f> #</a-f> run commands in project root
<a-o>$</a-o><a-f> </a-f><a-pr>mkdir</a-pr> <a-co>-p</a-co> /usr/share/man
<a-o>$</a-o><a-f> </a-f><a-pr>cp</a-pr> <a-co>-r</a-co> mons/man /usr/share/man</pre>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>`everest:` URI Scheme Registration</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text">![Everest 1-Click Install button on GameBanana](https://media.discordapp.net/attachments/850184494220312646/1029860061406838834/unknown.png)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"><a-p>##</a-p> <a-tt>Linux</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"><a-p>```</a-p><a-tl>console</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>$ cp mons.desktop ~/.local/share/applications/mons.desktop</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"><a-p>$ xdg-mime default ~/.local/share/applications/mons.desktop &quot;x-scheme-handler/everest&quot;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>$ update-desktop-database ~/.local/share/applications</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p># </a-p><a-tt>Manual Pages</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>## </a-p><a-tt>Build</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>&gt; [!NOTE]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>&gt; Pre-built man pages are distributed with the `mons` package within `mons/man/`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>```</a-p><a-tl>console</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>$ # run commands in project root</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>$ pip install -r requirements-dev.txt</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>$ sphinx-build -b man docs mons/man -d docs/_build</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>## </a-p><a-tt>Install</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>### </a-p><a-tt>Linux</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>```</a-p><a-tl>console</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>$ # run commands in project root</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>$ mkdir -p /usr/share/man</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>$ cp -r mons/man /usr/share/man</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>```</a-p></span></span></pre></div></div>
</main>
</body>
</html>
