mirror of
https://github.com/markqvist/Reticulum.git
synced 2024-11-05 05:40:14 +00:00
Updated documentation
This commit is contained in:
parent
5e5d89cc92
commit
da7a4433c0
@ -38,7 +38,6 @@ These efforts are aimed at improving the ease of which Reticulum is understood,
|
|||||||
- Update NomadNet screenshots
|
- Update NomadNet screenshots
|
||||||
- Update Sideband screenshots
|
- Update Sideband screenshots
|
||||||
- Installation
|
- Installation
|
||||||
- Remove references to netifaces
|
|
||||||
- Add a *Reticulum On Raspberry Pi* section
|
- Add a *Reticulum On Raspberry Pi* section
|
||||||
- Update *Reticulum On Android* section if necessary
|
- Update *Reticulum On Android* section if necessary
|
||||||
- Update Android install documentation.
|
- Update Android install documentation.
|
||||||
|
@ -25,30 +25,13 @@ and install them offline using ``pip``:
|
|||||||
|
|
||||||
.. code::
|
.. code::
|
||||||
|
|
||||||
pip install ./rns-0.4.6-py3-none-any.whl
|
pip install ./rns-0.5.1-py3-none-any.whl
|
||||||
|
|
||||||
|
|
||||||
Resolving Dependency & Installation Issues
|
Resolving Dependency & Installation Issues
|
||||||
=============================================
|
=============================================
|
||||||
On some platforms, there may not be binary packages available for all dependencies, and
|
On some platforms, there may not be binary packages available for all dependencies, and
|
||||||
``pip`` installation may fail with an error message. Most often, this is simply due to
|
``pip`` installation may fail with an error message. In these cases, the issue can usually
|
||||||
the ``netifaces`` package not having a pre-compiled package available via ``pip``.
|
|
||||||
|
|
||||||
Usually, this can be resolved by simply installing ``netifaces`` via the system package
|
|
||||||
manager:
|
|
||||||
|
|
||||||
.. code::
|
|
||||||
|
|
||||||
# Debian / Ubuntu / Derivatives
|
|
||||||
sudo apt install python3-netifaces
|
|
||||||
|
|
||||||
# Arch / Manjaro / Derivatives
|
|
||||||
sudo pamac install python3-netifaces
|
|
||||||
|
|
||||||
# Fedora
|
|
||||||
sudo dnf install python3-netifaces
|
|
||||||
|
|
||||||
More rarely, other dependencies cannot be resolved. In these cases, the issue can usually
|
|
||||||
be resolved by installing the development essentials packages for your platform:
|
be resolved by installing the development essentials packages for your platform:
|
||||||
|
|
||||||
.. code::
|
.. code::
|
||||||
@ -308,7 +291,7 @@ For extended functionality, you can install optional dependencies:
|
|||||||
|
|
||||||
.. code::
|
.. code::
|
||||||
|
|
||||||
pip3 install pyserial netifaces
|
pip3 install pyserial
|
||||||
|
|
||||||
|
|
||||||
Further information can be found in the :ref:`API Reference<api-main>`.
|
Further information can be found in the :ref:`API Reference<api-main>`.
|
||||||
@ -323,7 +306,7 @@ don't use pip, but try this recipe:
|
|||||||
.. code::
|
.. code::
|
||||||
|
|
||||||
# Install dependencies
|
# Install dependencies
|
||||||
pip3 install cryptography pyserial netifaces
|
pip3 install cryptography pyserial
|
||||||
|
|
||||||
# Clone repository
|
# Clone repository
|
||||||
git clone https://github.com/markqvist/Reticulum.git
|
git clone https://github.com/markqvist/Reticulum.git
|
||||||
@ -461,24 +444,6 @@ it will require manually configuring and installing some packages, and is not
|
|||||||
detailed in this manual.
|
detailed in this manual.
|
||||||
|
|
||||||
|
|
||||||
Fedora
|
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
|
||||||
On Fedora, ``pip`` installation may fail with an error message, since the ``netifaces``
|
|
||||||
package cannot be installed natively via ``pip``. This can be resolved by installing
|
|
||||||
the ``python3-netifaces`` package via ``dnf`` first:
|
|
||||||
|
|
||||||
.. code::
|
|
||||||
|
|
||||||
sudo dnf install python3-netifaces
|
|
||||||
|
|
||||||
Alternatively, you can install basic development packages, which will allow
|
|
||||||
``pip`` to install any required packages from source:
|
|
||||||
|
|
||||||
.. code::
|
|
||||||
|
|
||||||
sudo dnf groupinstall "Development Tools" "Development Libraries"
|
|
||||||
|
|
||||||
|
|
||||||
Debian Bookworm
|
Debian Bookworm
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
On versions of Debian released after April 2023, it is no longer possible
|
On versions of Debian released after April 2023, it is no longer possible
|
||||||
|
@ -238,28 +238,14 @@ of your system with a command like <code class="docutils literal notranslate"><s
|
|||||||
<code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">pamac</span> <span class="pre">install</span> <span class="pre">python-pip</span></code> or similar.</p>
|
<code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">pamac</span> <span class="pre">install</span> <span class="pre">python-pip</span></code> or similar.</p>
|
||||||
<p>You can also dowload the Reticulum release wheels from GitHub, or other release channels,
|
<p>You can also dowload the Reticulum release wheels from GitHub, or other release channels,
|
||||||
and install them offline using <code class="docutils literal notranslate"><span class="pre">pip</span></code>:</p>
|
and install them offline using <code class="docutils literal notranslate"><span class="pre">pip</span></code>:</p>
|
||||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">./</span><span class="n">rns</span><span class="o">-</span><span class="mf">0.4.6</span><span class="o">-</span><span class="n">py3</span><span class="o">-</span><span class="n">none</span><span class="o">-</span><span class="nb">any</span><span class="o">.</span><span class="n">whl</span>
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">./</span><span class="n">rns</span><span class="o">-</span><span class="mf">0.5.1</span><span class="o">-</span><span class="n">py3</span><span class="o">-</span><span class="n">none</span><span class="o">-</span><span class="nb">any</span><span class="o">.</span><span class="n">whl</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
<section id="resolving-dependency-installation-issues">
|
<section id="resolving-dependency-installation-issues">
|
||||||
<h2>Resolving Dependency & Installation Issues<a class="headerlink" href="#resolving-dependency-installation-issues" title="Permalink to this heading">#</a></h2>
|
<h2>Resolving Dependency & Installation Issues<a class="headerlink" href="#resolving-dependency-installation-issues" title="Permalink to this heading">#</a></h2>
|
||||||
<p>On some platforms, there may not be binary packages available for all dependencies, and
|
<p>On some platforms, there may not be binary packages available for all dependencies, and
|
||||||
<code class="docutils literal notranslate"><span class="pre">pip</span></code> installation may fail with an error message. Most often, this is simply due to
|
<code class="docutils literal notranslate"><span class="pre">pip</span></code> installation may fail with an error message. In these cases, the issue can usually
|
||||||
the <code class="docutils literal notranslate"><span class="pre">netifaces</span></code> package not having a pre-compiled package available via <code class="docutils literal notranslate"><span class="pre">pip</span></code>.</p>
|
|
||||||
<p>Usually, this can be resolved by simply installing <code class="docutils literal notranslate"><span class="pre">netifaces</span></code> via the system package
|
|
||||||
manager:</p>
|
|
||||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Debian / Ubuntu / Derivatives</span>
|
|
||||||
<span class="n">sudo</span> <span class="n">apt</span> <span class="n">install</span> <span class="n">python3</span><span class="o">-</span><span class="n">netifaces</span>
|
|
||||||
|
|
||||||
<span class="c1"># Arch / Manjaro / Derivatives</span>
|
|
||||||
<span class="n">sudo</span> <span class="n">pamac</span> <span class="n">install</span> <span class="n">python3</span><span class="o">-</span><span class="n">netifaces</span>
|
|
||||||
|
|
||||||
<span class="c1"># Fedora</span>
|
|
||||||
<span class="n">sudo</span> <span class="n">dnf</span> <span class="n">install</span> <span class="n">python3</span><span class="o">-</span><span class="n">netifaces</span>
|
|
||||||
</pre></div>
|
|
||||||
</div>
|
|
||||||
<p>More rarely, other dependencies cannot be resolved. In these cases, the issue can usually
|
|
||||||
be resolved by installing the development essentials packages for your platform:</p>
|
be resolved by installing the development essentials packages for your platform:</p>
|
||||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Debian / Ubuntu / Derivatives</span>
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Debian / Ubuntu / Derivatives</span>
|
||||||
<span class="n">sudo</span> <span class="n">apt</span> <span class="n">install</span> <span class="n">build</span><span class="o">-</span><span class="n">essential</span>
|
<span class="n">sudo</span> <span class="n">apt</span> <span class="n">install</span> <span class="n">build</span><span class="o">-</span><span class="n">essential</span>
|
||||||
@ -464,7 +450,7 @@ started is to install the latest release of Reticulum via pip:</p>
|
|||||||
ready to import and use RNS in your own programs. The next step will most
|
ready to import and use RNS in your own programs. The next step will most
|
||||||
likely be to look at some <a class="reference internal" href="examples.html#examples-main"><span class="std std-ref">Example Programs</span></a>.</p>
|
likely be to look at some <a class="reference internal" href="examples.html#examples-main"><span class="std std-ref">Example Programs</span></a>.</p>
|
||||||
<p>For extended functionality, you can install optional dependencies:</p>
|
<p>For extended functionality, you can install optional dependencies:</p>
|
||||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip3</span> <span class="n">install</span> <span class="n">pyserial</span> <span class="n">netifaces</span>
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip3</span> <span class="n">install</span> <span class="n">pyserial</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
<p>Further information can be found in the <a class="reference internal" href="reference.html#api-main"><span class="std std-ref">API Reference</span></a>.</p>
|
<p>Further information can be found in the <a class="reference internal" href="reference.html#api-main"><span class="std std-ref">API Reference</span></a>.</p>
|
||||||
@ -475,7 +461,7 @@ likely be to look at some <a class="reference internal" href="examples.html#exam
|
|||||||
utilities, you’ll want to get the latest source from GitHub. In that case,
|
utilities, you’ll want to get the latest source from GitHub. In that case,
|
||||||
don’t use pip, but try this recipe:</p>
|
don’t use pip, but try this recipe:</p>
|
||||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Install dependencies</span>
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Install dependencies</span>
|
||||||
<span class="n">pip3</span> <span class="n">install</span> <span class="n">cryptography</span> <span class="n">pyserial</span> <span class="n">netifaces</span>
|
<span class="n">pip3</span> <span class="n">install</span> <span class="n">cryptography</span> <span class="n">pyserial</span>
|
||||||
|
|
||||||
<span class="c1"># Clone repository</span>
|
<span class="c1"># Clone repository</span>
|
||||||
<span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">markqvist</span><span class="o">/</span><span class="n">Reticulum</span><span class="o">.</span><span class="n">git</span>
|
<span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">markqvist</span><span class="o">/</span><span class="n">Reticulum</span><span class="o">.</span><span class="n">git</span>
|
||||||
@ -598,20 +584,6 @@ don’t always have packages available for some dependencies.</p>
|
|||||||
it will require manually configuring and installing some packages, and is not
|
it will require manually configuring and installing some packages, and is not
|
||||||
detailed in this manual.</p>
|
detailed in this manual.</p>
|
||||||
</section>
|
</section>
|
||||||
<section id="fedora">
|
|
||||||
<h3>Fedora<a class="headerlink" href="#fedora" title="Permalink to this heading">#</a></h3>
|
|
||||||
<p>On Fedora, <code class="docutils literal notranslate"><span class="pre">pip</span></code> installation may fail with an error message, since the <code class="docutils literal notranslate"><span class="pre">netifaces</span></code>
|
|
||||||
package cannot be installed natively via <code class="docutils literal notranslate"><span class="pre">pip</span></code>. This can be resolved by installing
|
|
||||||
the <code class="docutils literal notranslate"><span class="pre">python3-netifaces</span></code> package via <code class="docutils literal notranslate"><span class="pre">dnf</span></code> first:</p>
|
|
||||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">dnf</span> <span class="n">install</span> <span class="n">python3</span><span class="o">-</span><span class="n">netifaces</span>
|
|
||||||
</pre></div>
|
|
||||||
</div>
|
|
||||||
<p>Alternatively, you can install basic development packages, which will allow
|
|
||||||
<code class="docutils literal notranslate"><span class="pre">pip</span></code> to install any required packages from source:</p>
|
|
||||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">dnf</span> <span class="n">groupinstall</span> <span class="s2">"Development Tools"</span> <span class="s2">"Development Libraries"</span>
|
|
||||||
</pre></div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
<section id="debian-bookworm">
|
<section id="debian-bookworm">
|
||||||
<h3>Debian Bookworm<a class="headerlink" href="#debian-bookworm" title="Permalink to this heading">#</a></h3>
|
<h3>Debian Bookworm<a class="headerlink" href="#debian-bookworm" title="Permalink to this heading">#</a></h3>
|
||||||
<p>On versions of Debian released after April 2023, it is no longer possible
|
<p>On versions of Debian released after April 2023, it is no longer possible
|
||||||
@ -749,7 +721,6 @@ section of this manual.</p>
|
|||||||
<li><a class="reference internal" href="#android">Android</a></li>
|
<li><a class="reference internal" href="#android">Android</a></li>
|
||||||
<li><a class="reference internal" href="#arm64">ARM64</a></li>
|
<li><a class="reference internal" href="#arm64">ARM64</a></li>
|
||||||
<li><a class="reference internal" href="#raspberry-pi">Raspberry Pi</a></li>
|
<li><a class="reference internal" href="#raspberry-pi">Raspberry Pi</a></li>
|
||||||
<li><a class="reference internal" href="#fedora">Fedora</a></li>
|
|
||||||
<li><a class="reference internal" href="#debian-bookworm">Debian Bookworm</a></li>
|
<li><a class="reference internal" href="#debian-bookworm">Debian Bookworm</a></li>
|
||||||
<li><a class="reference internal" href="#ubuntu-lunar">Ubuntu Lunar</a></li>
|
<li><a class="reference internal" href="#ubuntu-lunar">Ubuntu Lunar</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
@ -260,7 +260,6 @@ to participate in the development of Reticulum itself.</p>
|
|||||||
<li class="toctree-l3"><a class="reference internal" href="gettingstartedfast.html#android">Android</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="gettingstartedfast.html#android">Android</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="gettingstartedfast.html#arm64">ARM64</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="gettingstartedfast.html#arm64">ARM64</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="gettingstartedfast.html#raspberry-pi">Raspberry Pi</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="gettingstartedfast.html#raspberry-pi">Raspberry Pi</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="gettingstartedfast.html#fedora">Fedora</a></li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="gettingstartedfast.html#debian-bookworm">Debian Bookworm</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="gettingstartedfast.html#debian-bookworm">Debian Bookworm</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="gettingstartedfast.html#ubuntu-lunar">Ubuntu Lunar</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="gettingstartedfast.html#ubuntu-lunar">Ubuntu Lunar</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
File diff suppressed because one or more lines are too long
@ -25,30 +25,13 @@ and install them offline using ``pip``:
|
|||||||
|
|
||||||
.. code::
|
.. code::
|
||||||
|
|
||||||
pip install ./rns-0.4.6-py3-none-any.whl
|
pip install ./rns-0.5.1-py3-none-any.whl
|
||||||
|
|
||||||
|
|
||||||
Resolving Dependency & Installation Issues
|
Resolving Dependency & Installation Issues
|
||||||
=============================================
|
=============================================
|
||||||
On some platforms, there may not be binary packages available for all dependencies, and
|
On some platforms, there may not be binary packages available for all dependencies, and
|
||||||
``pip`` installation may fail with an error message. Most often, this is simply due to
|
``pip`` installation may fail with an error message. In these cases, the issue can usually
|
||||||
the ``netifaces`` package not having a pre-compiled package available via ``pip``.
|
|
||||||
|
|
||||||
Usually, this can be resolved by simply installing ``netifaces`` via the system package
|
|
||||||
manager:
|
|
||||||
|
|
||||||
.. code::
|
|
||||||
|
|
||||||
# Debian / Ubuntu / Derivatives
|
|
||||||
sudo apt install python3-netifaces
|
|
||||||
|
|
||||||
# Arch / Manjaro / Derivatives
|
|
||||||
sudo pamac install python3-netifaces
|
|
||||||
|
|
||||||
# Fedora
|
|
||||||
sudo dnf install python3-netifaces
|
|
||||||
|
|
||||||
More rarely, other dependencies cannot be resolved. In these cases, the issue can usually
|
|
||||||
be resolved by installing the development essentials packages for your platform:
|
be resolved by installing the development essentials packages for your platform:
|
||||||
|
|
||||||
.. code::
|
.. code::
|
||||||
@ -308,7 +291,7 @@ For extended functionality, you can install optional dependencies:
|
|||||||
|
|
||||||
.. code::
|
.. code::
|
||||||
|
|
||||||
pip3 install pyserial netifaces
|
pip3 install pyserial
|
||||||
|
|
||||||
|
|
||||||
Further information can be found in the :ref:`API Reference<api-main>`.
|
Further information can be found in the :ref:`API Reference<api-main>`.
|
||||||
@ -323,7 +306,7 @@ don't use pip, but try this recipe:
|
|||||||
.. code::
|
.. code::
|
||||||
|
|
||||||
# Install dependencies
|
# Install dependencies
|
||||||
pip3 install cryptography pyserial netifaces
|
pip3 install cryptography pyserial
|
||||||
|
|
||||||
# Clone repository
|
# Clone repository
|
||||||
git clone https://github.com/markqvist/Reticulum.git
|
git clone https://github.com/markqvist/Reticulum.git
|
||||||
@ -461,24 +444,6 @@ it will require manually configuring and installing some packages, and is not
|
|||||||
detailed in this manual.
|
detailed in this manual.
|
||||||
|
|
||||||
|
|
||||||
Fedora
|
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
|
||||||
On Fedora, ``pip`` installation may fail with an error message, since the ``netifaces``
|
|
||||||
package cannot be installed natively via ``pip``. This can be resolved by installing
|
|
||||||
the ``python3-netifaces`` package via ``dnf`` first:
|
|
||||||
|
|
||||||
.. code::
|
|
||||||
|
|
||||||
sudo dnf install python3-netifaces
|
|
||||||
|
|
||||||
Alternatively, you can install basic development packages, which will allow
|
|
||||||
``pip`` to install any required packages from source:
|
|
||||||
|
|
||||||
.. code::
|
|
||||||
|
|
||||||
sudo dnf groupinstall "Development Tools" "Development Libraries"
|
|
||||||
|
|
||||||
|
|
||||||
Debian Bookworm
|
Debian Bookworm
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
On versions of Debian released after April 2023, it is no longer possible
|
On versions of Debian released after April 2023, it is no longer possible
|
||||||
|
Loading…
Reference in New Issue
Block a user