mirror of
https://github.com/markqvist/Reticulum.git
synced 2024-12-22 20:00:18 +00:00
Updated docs and manual
This commit is contained in:
parent
890846fa8d
commit
44782c3429
Binary file not shown.
Binary file not shown.
@ -14,16 +14,21 @@ for Reticulum to use.
|
||||
The following sections describe the interfaces currently available in Reticulum,
|
||||
and gives example configurations for the respective interface types.
|
||||
|
||||
In addition to the built-in interface types, Reticulum is fully extensible with
|
||||
custom, user- or community-supplied interfaces, and creating custom interface
|
||||
modules is straightforward. Please see the :ref:`custom interface<example-custominterface>`
|
||||
example for basic interface code to build upon.
|
||||
|
||||
For a high-level overview of how networks can be formed over different interface
|
||||
types, have a look at the :ref:`Building Networks<networks-main>` chapter of this
|
||||
manual.
|
||||
|
||||
|
||||
.. _interfaces-custom:
|
||||
|
||||
Custom Interfaces
|
||||
=================
|
||||
|
||||
In addition to the built-in interface types, Reticulum is **fully extensible** with
|
||||
custom, user- or community-supplied interfaces, and creating custom interface
|
||||
modules is straightforward. Please see the :ref:`custom interface<example-custominterface>`
|
||||
example for basic interface code to build upon.
|
||||
|
||||
.. _interfaces-auto:
|
||||
|
||||
Auto Interface
|
||||
|
@ -333,6 +333,7 @@ to participate in the development of Reticulum itself.</p>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="interfaces.html">Configuring Interfaces</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#custom-interfaces">Custom Interfaces</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#auto-interface">Auto Interface</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#i2p-interface">I2P Interface</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#tcp-server-interface">TCP Server Interface</a></li>
|
||||
|
@ -230,13 +230,16 @@ common to them all is that you will need to define one or more <em>interfaces</e
|
||||
for Reticulum to use.</p>
|
||||
<p>The following sections describe the interfaces currently available in Reticulum,
|
||||
and gives example configurations for the respective interface types.</p>
|
||||
<p>In addition to the built-in interface types, Reticulum is fully extensible with
|
||||
custom, user- or community-supplied interfaces, and creating custom interface
|
||||
modules is straightforward. Please see the <a class="reference internal" href="examples.html#example-custominterface"><span class="std std-ref">custom interface</span></a>
|
||||
example for basic interface code to build upon.</p>
|
||||
<p>For a high-level overview of how networks can be formed over different interface
|
||||
types, have a look at the <a class="reference internal" href="networks.html#networks-main"><span class="std std-ref">Building Networks</span></a> chapter of this
|
||||
manual.</p>
|
||||
<section id="custom-interfaces">
|
||||
<span id="interfaces-custom"></span><h2>Custom Interfaces<a class="headerlink" href="#custom-interfaces" title="Permalink to this heading">#</a></h2>
|
||||
<p>In addition to the built-in interface types, Reticulum is <strong>fully extensible</strong> with
|
||||
custom, user- or community-supplied interfaces, and creating custom interface
|
||||
modules is straightforward. Please see the <a class="reference internal" href="examples.html#example-custominterface"><span class="std std-ref">custom interface</span></a>
|
||||
example for basic interface code to build upon.</p>
|
||||
</section>
|
||||
<section id="auto-interface">
|
||||
<span id="interfaces-auto"></span><h2>Auto Interface<a class="headerlink" href="#auto-interface" title="Permalink to this heading">#</a></h2>
|
||||
<p>The Auto Interface enables communication with other discoverable Reticulum
|
||||
@ -1263,6 +1266,7 @@ to <code class="docutils literal notranslate"><span class="pre">30</span></code>
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Configuring Interfaces</a><ul>
|
||||
<li><a class="reference internal" href="#custom-interfaces">Custom Interfaces</a></li>
|
||||
<li><a class="reference internal" href="#auto-interface">Auto Interface</a></li>
|
||||
<li><a class="reference internal" href="#i2p-interface">I2P Interface</a></li>
|
||||
<li><a class="reference internal" href="#tcp-server-interface">TCP Server Interface</a></li>
|
||||
|
Binary file not shown.
File diff suppressed because one or more lines are too long
@ -14,16 +14,21 @@ for Reticulum to use.
|
||||
The following sections describe the interfaces currently available in Reticulum,
|
||||
and gives example configurations for the respective interface types.
|
||||
|
||||
In addition to the built-in interface types, Reticulum is fully extensible with
|
||||
custom, user- or community-supplied interfaces, and creating custom interface
|
||||
modules is straightforward. Please see the :ref:`custom interface<example-custominterface>`
|
||||
example for basic interface code to build upon.
|
||||
|
||||
For a high-level overview of how networks can be formed over different interface
|
||||
types, have a look at the :ref:`Building Networks<networks-main>` chapter of this
|
||||
manual.
|
||||
|
||||
|
||||
.. _interfaces-custom:
|
||||
|
||||
Custom Interfaces
|
||||
=================
|
||||
|
||||
In addition to the built-in interface types, Reticulum is **fully extensible** with
|
||||
custom, user- or community-supplied interfaces, and creating custom interface
|
||||
modules is straightforward. Please see the :ref:`custom interface<example-custominterface>`
|
||||
example for basic interface code to build upon.
|
||||
|
||||
.. _interfaces-auto:
|
||||
|
||||
Auto Interface
|
||||
|
Loading…
Reference in New Issue
Block a user