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

Updated documentation

Browse Source
This commit is contained in:
Mark Qvist 2022-06-22 16:10:54 +02:00
parent a99031873d
commit 1c4528dca1
6 changed files with 63 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/Reticulum Manual.pdf
View File

Binary file not shown.

28
docs/manual/_sources/support.rst.txt
View File

@ -3,29 +3,32 @@
***************** *****************
Support Reticulum Support Reticulum
***************** *****************
This reference guide lists and explains all classes exposed by the RNS API. You can help support the continued development of open, free and private communications
systems by donating, providing feedback and contributing code and learning resources.
Donations Donations
========= =========
You can help support the continued development of open, free and private communications systems by donating via one of the following channels: Donations are gratefully accepted via the following channels:
.. code:: text
Monero: Monero:
84FpY1QbxHcgdseePYNmhTHcrgMX4nFf 84FpY1QbxHcgdseePYNmhTHcrgMX4nFf
BYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD1 BYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD1
9b3B8NiLCGVxzKV17UMmmeEsCrPyA5w 9b3B8NiLCGVxzKV17UMmmeEsCrPyA5w
Ethereum Ethereum:
0x81F7B979fEa6134bA9FD5c701b3501A2e61E897a 0x81F7B979fEa6134bA9FD5c701b3501A2e61E897a
Bitcoin Bitcoin:
3CPmacGm34qYvR6XWLVEJmi2aNe3PZqUuq 3CPmacGm34qYvR6XWLVEJmi2aNe3PZqUuq
Ko-Fi: https://ko-fi.com/markqvist Ko-Fi:
https://ko-fi.com/markqvist
Are certain features in the development roadmap are important to you or your organisation? Make them a reality quickly by sponsoring their implementation. Are certain features in the development roadmap are important to you or your
organisation? Make them a reality quickly by sponsoring their implementation.
Provide Feedback Provide Feedback
================ ================
@ -33,4 +36,9 @@ All feedback on the usage, functioning and potential dysfunctioning of any and
all components of the system is very valuable to the continued development and all components of the system is very valuable to the continued development and
improvement of Reticulum. Absolutely no automated analytics, telemetly, error improvement of Reticulum. Absolutely no automated analytics, telemetly, error
reporting or statistics is collected and reported by Reticulum under any reporting or statistics is collected and reported by Reticulum under any
circumstances, so we rely on old-fashioned human feedback. circumstances, so we rely on old-fashioned human feedback.
Contribute Code
===============
Join us on `the GitHub repository <https://github.com/markqvist/reticulum>`_ to
report issues, suggest functionality and contribute code to Reticulum.

1
docs/manual/index.html
View File

@ -184,6 +184,7 @@ to participate in the development of Reticulum itself.</p>
<li class="toctree-l1"><a class="reference internal" href="support.html">Support Reticulum</a><ul> <li class="toctree-l1"><a class="reference internal" href="support.html">Support Reticulum</a><ul>
<li class="toctree-l2"><a class="reference internal" href="support.html#donations">Donations</a></li> <li class="toctree-l2"><a class="reference internal" href="support.html#donations">Donations</a></li>
<li class="toctree-l2"><a class="reference internal" href="support.html#provide-feedback">Provide Feedback</a></li> <li class="toctree-l2"><a class="reference internal" href="support.html#provide-feedback">Provide Feedback</a></li>
<li class="toctree-l2"><a class="reference internal" href="support.html#contribute-code">Contribute Code</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>

2
docs/manual/searchindex.js
View File

File diff suppressed because one or more lines are too long

38
docs/manual/support.html
View File

@ -39,22 +39,28 @@
<div class="section" id="support-reticulum"> <div class="section" id="support-reticulum">
<span id="support-main"></span><h1>Support Reticulum<a class="headerlink" href="#support-reticulum" title="Permalink to this headline"></a></h1> <span id="support-main"></span><h1>Support Reticulum<a class="headerlink" href="#support-reticulum" title="Permalink to this headline"></a></h1>
<p>This reference guide lists and explains all classes exposed by the RNS API.</p> <p>You can help support the continued development of open, free and private communications
systems by donating, providing feedback and contributing code and learning resources.</p>
<div class="section" id="donations"> <div class="section" id="donations">
<h2>Donations<a class="headerlink" href="#donations" title="Permalink to this headline"></a></h2> <h2>Donations<a class="headerlink" href="#donations" title="Permalink to this headline"></a></h2>
<p>You can help support the continued development of open, free and private communications systems by donating via one of the following channels:</p> <p>Donations are gratefully accepted via the following channels:</p>
<blockquote> <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Monero:
<div><p>Monero:</p> 84FpY1QbxHcgdseePYNmhTHcrgMX4nFf
<p>84FpY1QbxHcgdseePYNmhTHcrgMX4nFf
BYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD1 BYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD1
9b3B8NiLCGVxzKV17UMmmeEsCrPyA5w</p> 9b3B8NiLCGVxzKV17UMmmeEsCrPyA5w
<p>Ethereum</p>
<p>0x81F7B979fEa6134bA9FD5c701b3501A2e61E897a</p> Ethereum:
<p>Bitcoin</p> 0x81F7B979fEa6134bA9FD5c701b3501A2e61E897a
<p>3CPmacGm34qYvR6XWLVEJmi2aNe3PZqUuq</p>
<p>Ko-Fi: <a class="reference external" href="https://ko-fi.com/markqvist">https://ko-fi.com/markqvist</a></p> Bitcoin:
</div></blockquote> 3CPmacGm34qYvR6XWLVEJmi2aNe3PZqUuq
<p>Are certain features in the development roadmap are important to you or your organisation? Make them a reality quickly by sponsoring their implementation.</p>
Ko-Fi:
https://ko-fi.com/markqvist
</pre></div>
</div>
<p>Are certain features in the development roadmap are important to you or your
organisation? Make them a reality quickly by sponsoring their implementation.</p>
</div> </div>
<div class="section" id="provide-feedback"> <div class="section" id="provide-feedback">
<h2>Provide Feedback<a class="headerlink" href="#provide-feedback" title="Permalink to this headline"></a></h2> <h2>Provide Feedback<a class="headerlink" href="#provide-feedback" title="Permalink to this headline"></a></h2>
@ -64,6 +70,11 @@ improvement of Reticulum. Absolutely no automated analytics, telemetly, error
reporting or statistics is collected and reported by Reticulum under any reporting or statistics is collected and reported by Reticulum under any
circumstances, so we rely on old-fashioned human feedback.</p> circumstances, so we rely on old-fashioned human feedback.</p>
</div> </div>
<div class="section" id="contribute-code">
<h2>Contribute Code<a class="headerlink" href="#contribute-code" title="Permalink to this headline"></a></h2>
<p>Join us on <a class="reference external" href="https://github.com/markqvist/reticulum">the GitHub repository</a> to
report issues, suggest functionality and contribute code to Reticulum.</p>
</div>
</div> </div>
@ -78,6 +89,7 @@ circumstances, so we rely on old-fashioned human feedback.</p>
<li><a class="reference internal" href="#">Support Reticulum</a><ul> <li><a class="reference internal" href="#">Support Reticulum</a><ul>
<li><a class="reference internal" href="#donations">Donations</a></li> <li><a class="reference internal" href="#donations">Donations</a></li>
<li><a class="reference internal" href="#provide-feedback">Provide Feedback</a></li> <li><a class="reference internal" href="#provide-feedback">Provide Feedback</a></li>
<li><a class="reference internal" href="#contribute-code">Contribute Code</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>

28
docs/source/support.rst
View File

@ -3,29 +3,32 @@
***************** *****************
Support Reticulum Support Reticulum
***************** *****************
This reference guide lists and explains all classes exposed by the RNS API. You can help support the continued development of open, free and private communications
systems by donating, providing feedback and contributing code and learning resources.
Donations Donations
========= =========
You can help support the continued development of open, free and private communications systems by donating via one of the following channels: Donations are gratefully accepted via the following channels:
.. code:: text
Monero: Monero:
84FpY1QbxHcgdseePYNmhTHcrgMX4nFf 84FpY1QbxHcgdseePYNmhTHcrgMX4nFf
BYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD1 BYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD1
9b3B8NiLCGVxzKV17UMmmeEsCrPyA5w 9b3B8NiLCGVxzKV17UMmmeEsCrPyA5w
Ethereum Ethereum:
0x81F7B979fEa6134bA9FD5c701b3501A2e61E897a 0x81F7B979fEa6134bA9FD5c701b3501A2e61E897a
Bitcoin Bitcoin:
3CPmacGm34qYvR6XWLVEJmi2aNe3PZqUuq 3CPmacGm34qYvR6XWLVEJmi2aNe3PZqUuq
Ko-Fi: https://ko-fi.com/markqvist Ko-Fi:
https://ko-fi.com/markqvist
Are certain features in the development roadmap are important to you or your organisation? Make them a reality quickly by sponsoring their implementation. Are certain features in the development roadmap are important to you or your
organisation? Make them a reality quickly by sponsoring their implementation.
Provide Feedback Provide Feedback
================ ================
@ -33,4 +36,9 @@ All feedback on the usage, functioning and potential dysfunctioning of any and
all components of the system is very valuable to the continued development and all components of the system is very valuable to the continued development and
improvement of Reticulum. Absolutely no automated analytics, telemetly, error improvement of Reticulum. Absolutely no automated analytics, telemetly, error
reporting or statistics is collected and reported by Reticulum under any reporting or statistics is collected and reported by Reticulum under any
circumstances, so we rely on old-fashioned human feedback. circumstances, so we rely on old-fashioned human feedback.
Contribute Code
===============
Join us on `the GitHub repository <https://github.com/markqvist/reticulum>`_ to
report issues, suggest functionality and contribute code to Reticulum.