diff --git a/docs/manual/.buildinfo b/docs/manual/.buildinfo index 0f46a30..45e6b9a 100644 --- a/docs/manual/.buildinfo +++ b/docs/manual/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: d8447d44585d036754ef13c1e3b2bcb2 +config: ab776c37991b695fba62f8d653f98b5e tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/manual/_sources/gettingstartedfast.rst.txt b/docs/manual/_sources/gettingstartedfast.rst.txt index 1683108..ecd4389 100644 --- a/docs/manual/_sources/gettingstartedfast.rst.txt +++ b/docs/manual/_sources/gettingstartedfast.rst.txt @@ -10,22 +10,62 @@ scenarios. Standalone Reticulum Installation ============================================= If you simply want to install Reticulum and related utilities on a system, -the easiest way is via ``pip``: +the easiest way is via the ``pip`` package manager: .. code:: pip install rns -If you no not already have pip installed, you can install it using the package manager +If you do not already have pip installed, you can install it using the package manager of your system with a command like ``sudo apt install python3-pip``, -``sudo pamac install python-pip`` or similar. You can also dowload the Reticulum release -wheels from GitHub, or other release channels, and install them offline using ``pip``: +``sudo pamac install python-pip`` or similar. + +You can also dowload the Reticulum release wheels from GitHub, or other release channels, +and install them offline using ``pip``: .. code:: pip install ./rns-0.4.6-py3-none-any.whl +Resolving Dependency & Installation Issues +============================================= +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 +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: + +.. code:: + + # Debian / Ubuntu / Derivatives + sudo apt install build-essential + + # Arch / Manjaro / Derivatives + sudo pamac install base-devel + + # Fedora + sudo dnf groupinstall "Development Tools" "Development Libraries" + +With the base development packages installed, ``pip`` should be able to compile any missing +dependencies from source, and complete installation even on platforms that don't have pre- +compiled packages available. + Try Using a Reticulum-based Program ============================================= @@ -320,8 +360,14 @@ the `disucssion forum on GitHub `_. diff --git a/docs/manual/_static/documentation_options.js b/docs/manual/_static/documentation_options.js index 43e8116..53a6402 100644 --- a/docs/manual/_static/documentation_options.js +++ b/docs/manual/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '0.5.0 beta', + VERSION: '0.5.1 beta', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/manual/examples.html b/docs/manual/examples.html index 28e301b..34a5d15 100644 --- a/docs/manual/examples.html +++ b/docs/manual/examples.html @@ -6,7 +6,7 @@ - Code Examples - Reticulum Network Stack 0.5.0 beta documentation + Code Examples - Reticulum Network Stack 0.5.1 beta documentation @@ -141,7 +141,7 @@
-
Reticulum Network Stack 0.5.0 beta documentation
 +
Reticulum Network Stack 0.5.1 beta documentation
@@ -167,7 +167,7 @@
- Reticulum Network Stack 0.5.0 beta documentation + Reticulum Network Stack 0.5.1 beta documentation
-
Reticulum Network Stack 0.5.0 beta documentation
 +
Reticulum Network Stack 0.5.1 beta documentation
@@ -167,7 +167,7 @@
- Reticulum Network Stack 0.5.0 beta documentation + Reticulum Network Stack 0.5.1 beta documentation diff --git a/docs/manual/genindex.html b/docs/manual/genindex.html index b84600a..7ce5eb8 100644 --- a/docs/manual/genindex.html +++ b/docs/manual/genindex.html @@ -4,7 +4,7 @@ - Index - Reticulum Network Stack 0.5.0 beta documentation + Index - Reticulum Network Stack 0.5.1 beta documentation @@ -139,7 +139,7 @@
-
Reticulum Network Stack 0.5.0 beta documentation
 +
Reticulum Network Stack 0.5.1 beta documentation
@@ -165,7 +165,7 @@
- Reticulum Network Stack 0.5.0 beta documentation + Reticulum Network Stack 0.5.1 beta documentation diff --git a/docs/manual/gettingstartedfast.html b/docs/manual/gettingstartedfast.html index 2656725..4c7967a 100644 --- a/docs/manual/gettingstartedfast.html +++ b/docs/manual/gettingstartedfast.html @@ -6,7 +6,7 @@ - Getting Started Fast - Reticulum Network Stack 0.5.0 beta documentation + Getting Started Fast - Reticulum Network Stack 0.5.1 beta documentation @@ -141,7 +141,7 @@
-
Reticulum Network Stack 0.5.0 beta documentation
 +
Reticulum Network Stack 0.5.1 beta documentation
@@ -167,7 +167,7 @@
- Reticulum Network Stack 0.5.0 beta documentation + Reticulum Network Stack 0.5.1 beta documentation @@ -229,18 +229,52 @@ scenarios.

Standalone Reticulum Installation#

If you simply want to install Reticulum and related utilities on a system, -the easiest way is via pip:

+the easiest way is via the pip package manager:

pip install rns
-

If you no not already have pip installed, you can install it using the package manager +

If you do not already have pip installed, you can install it using the package manager of your system with a command like sudo apt install python3-pip, -sudo pamac install python-pip or similar. You can also dowload the Reticulum release -wheels from GitHub, or other release channels, and install them offline using pip:

+sudo pamac install python-pip or similar.

+

You can also dowload the Reticulum release wheels from GitHub, or other release channels, +and install them offline using pip:

pip install ./rns-0.4.6-py3-none-any.whl
+
+

Resolving Dependency & Installation Issues#

+

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 +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:

+
# 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:

+
# Debian / Ubuntu / Derivatives
+sudo apt install build-essential
+
+# Arch / Manjaro / Derivatives
+sudo pamac install base-devel
+
+# Fedora
+sudo dnf groupinstall "Development Tools" "Development Libraries"
+
+
+

With the base development packages installed, pip should be able to compile any missing +dependencies from source, and complete installation even on platforms that don’t have pre- +compiled packages available.

+

Try Using a Reticulum-based Program#

If you simply want to try using a program built with Reticulum, a few different @@ -478,8 +512,12 @@ your first pull request, it is probably a good idea to introduce yourself on the disucssion forum on GitHub, or ask one of the developers or maintainers for a good place to start.

+
+

Platform-Specific Install Notes#

+

Some platforms require a slightly different installation procedure, or have +various quirks that are worth being aware of. These are listed here.

-

Reticulum on ARM64#

+

Reticulum on ARM64#

On some architectures, including ARM64, not all dependencies have precompiled binaries. On such systems, you may need to install python3-dev before installing Reticulum or programs that depend on Reticulum.

@@ -493,13 +531,30 @@ installing Reticulum or programs that depend on Reticulum.

-

Reticulum on Raspberry Pi#

+

Reticulum on Raspberry Pi#

It is currently recommended to use a 64-bit version of the Raspberry Pi OS if you want to run Reticulum on Raspberry Pi computers, since 32-bit versions don’t always have packages available for some dependencies.

+

While it is possible to install and run Reticulum on 32-bit Rasperry Pi OSes, +it will require manually configuring and installing some packages, and is not +detailed in this manual.

+
+
+

Reticulum on 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:

+
sudo dnf install python3-netifaces
+
+
+

Alternatively, you can install basic development packages, which will allow +pip to install any required packages from source:

+
sudo dnf groupinstall "Development Tools" "Development Libraries"
+
+
-

Reticulum on Android#

+

Reticulum on Android#

Reticulum can be used on Android in different ways. The easiest way to get started is using an app like Sideband.

For more control and features, you can use Reticulum and related programs via @@ -557,6 +612,7 @@ locally on your device using the following command:

Android APKs. A detailed tutorial and example source code will be included here at a later point. Until then you can use the Sideband source code as an example and startig point.

+

Pure-Python Reticulum#

In some rare cases, and on more obscure system types, it is not possible to @@ -639,6 +695,7 @@ section of this manual.