jacob.eva/Reticulum
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated docs

Browse Source
This commit is contained in:
Mark Qvist 2021-12-09 18:53:28 +01:00
parent 81fed10855
commit 6500bc7390
7 changed files with 28 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/manual/_sources/gettingstartedfast.rst.txt
View File

@ -175,6 +175,10 @@ From within Termux, execute the following:
# Make sure pip is up to date, and install the wheel module. # Make sure pip is up to date, and install the wheel module.
pip3 install wheel pip --upgrade pip3 install wheel pip --upgrade
# To allow the installer to build the cryptography module,
# we need to let it know what platform we are compiling for:
export CARGO_BUILD_TARGET="aarch64-linux-android"
# Start the install process for the cryptography module. # Start the install process for the cryptography module.
# Depending on your device, this can take several minutes, # Depending on your device, this can take several minutes,
# since the module must be compiled locally on your device. # since the module must be compiled locally on your device.

10
docs/manual/_sources/interfaces.rst.txt
View File

@ -24,11 +24,11 @@ Auto Interface
============== ==============
The Auto Interface enables communication with other discoverable Reticulum The Auto Interface enables communication with other discoverable Reticulum
nodes over UDP. It does not need any functional IP infrastructure like nodes over autoconfigured IPv6 and UDP. It does not need any functional IP
routers or DHCP servers, but will require at least some sort of switching infrastructure like routers or DHCP servers, but will require at least some
medium between peers (a wired switch, a hub, a WiFi access point or similar), and sort of switching medium between peers (a wired switch, a hub, a WiFi access
that link-local IPv6 is enabled in your operating system, which should be point or similar), and that link-local IPv6 is enabled in your operating
enabled by default in almost all OSes. system, which should be enabled by default in almost all OSes.
.. code:: .. code::

4
docs/manual/gettingstartedfast.html
View File

@ -184,6 +184,10 @@ and a few extra commands are required.</p>
<span class="c1"># Make sure pip is up to date, and install the wheel module.</span> <span class="c1"># Make sure pip is up to date, and install the wheel module.</span>
<span class="n">pip3</span> <span class="n">install</span> <span class="n">wheel</span> <span class="n">pip</span> <span class="o">--</span><span class="n">upgrade</span> <span class="n">pip3</span> <span class="n">install</span> <span class="n">wheel</span> <span class="n">pip</span> <span class="o">--</span><span class="n">upgrade</span>
<span class="c1"># To allow the installer to build the cryptography module,</span>
<span class="c1"># we need to let it know what platform we are compiling for:</span>
<span class="n">export</span> <span class="n">CARGO_BUILD_TARGET</span><span class="o">=</span><span class="s2">&quot;aarch64-linux-android&quot;</span>
<span class="c1"># Start the install process for the cryptography module.</span> <span class="c1"># Start the install process for the cryptography module.</span>
<span class="c1"># Depending on your device, this can take several minutes,</span> <span class="c1"># Depending on your device, this can take several minutes,</span>
<span class="c1"># since the module must be compiled locally on your device.</span> <span class="c1"># since the module must be compiled locally on your device.</span>

10
docs/manual/interfaces.html
View File

@ -56,11 +56,11 @@ manual.</p>
<div class="section" id="auto-interface"> <div class="section" id="auto-interface">
<span id="interfaces-auto"></span><h2>Auto Interface<a class="headerlink" href="#auto-interface" title="Permalink to this headline"></a></h2> <span id="interfaces-auto"></span><h2>Auto Interface<a class="headerlink" href="#auto-interface" title="Permalink to this headline"></a></h2>
<p>The Auto Interface enables communication with other discoverable Reticulum <p>The Auto Interface enables communication with other discoverable Reticulum
nodes over UDP. It does not need any functional IP infrastructure like nodes over autoconfigured IPv6 and UDP. It does not need any functional IP
routers or DHCP servers, but will require at least some sort of switching infrastructure like routers or DHCP servers, but will require at least some
medium between peers (a wired switch, a hub, a WiFi access point or similar), and sort of switching medium between peers (a wired switch, a hub, a WiFi access
that link-local IPv6 is enabled in your operating system, which should be point or similar), and that link-local IPv6 is enabled in your operating
enabled by default in almost all OSes.</p> system, which should be enabled by default in almost all OSes.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># This example demonstrates a TCP server interface.</span> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># This example demonstrates a TCP server interface.</span>
<span class="c1"># It will listen for incoming connections on the</span> <span class="c1"># It will listen for incoming connections on the</span>
<span class="c1"># specified IP address and port number.</span> <span class="c1"># specified IP address and port number.</span>

2
docs/manual/searchindex.js
View File

File diff suppressed because one or more lines are too long

4
docs/source/gettingstartedfast.rst
View File

@ -175,6 +175,10 @@ From within Termux, execute the following:
# Make sure pip is up to date, and install the wheel module. # Make sure pip is up to date, and install the wheel module.
pip3 install wheel pip --upgrade pip3 install wheel pip --upgrade
# To allow the installer to build the cryptography module,
# we need to let it know what platform we are compiling for:
export CARGO_BUILD_TARGET="aarch64-linux-android"
# Start the install process for the cryptography module. # Start the install process for the cryptography module.
# Depending on your device, this can take several minutes, # Depending on your device, this can take several minutes,
# since the module must be compiled locally on your device. # since the module must be compiled locally on your device.

10
docs/source/interfaces.rst
View File

@ -24,11 +24,11 @@ Auto Interface
============== ==============
The Auto Interface enables communication with other discoverable Reticulum The Auto Interface enables communication with other discoverable Reticulum
nodes over UDP. It does not need any functional IP infrastructure like nodes over autoconfigured IPv6 and UDP. It does not need any functional IP
routers or DHCP servers, but will require at least some sort of switching infrastructure like routers or DHCP servers, but will require at least some
medium between peers (a wired switch, a hub, a WiFi access point or similar), and sort of switching medium between peers (a wired switch, a hub, a WiFi access
that link-local IPv6 is enabled in your operating system, which should be point or similar), and that link-local IPv6 is enabled in your operating
enabled by default in almost all OSes. system, which should be enabled by default in almost all OSes.
.. code:: .. code::