Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
markqvist committed Sep 25, 2021
1 parent c14f6aa commit dcde503
Show file tree
Hide file tree
Showing 29 changed files with 2,335 additions and 59 deletions.
2 changes: 1 addition & 1 deletion RNS/Utilities/rnpath.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ def program_setup(configdir, destination_hexhash, verbosity):
next_hop = RNS.prettyhexrep(reticulum.get_next_hop(destination_hash))
next_hop_interface = reticulum.get_next_hop_if_name(destination_hash)

if hops > 1:
if hops != 1:
ms = "s"
else:
ms = ""
Expand Down
4 changes: 2 additions & 2 deletions RNS/Utilities/rnprobe.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ def program_setup(configdir, destination_hexhash, size=DEFAULT_PROBE_SIZE, full_
receipt = probe.send()

if more_output:
more = " via "+RNS.prettyhexrep(RNS.Transport.next_hop(destination_hash))+" on "+str(RNS.Transport.next_hop_interface(destination_hash))
more = " via "+RNS.prettyhexrep(reticulum.get_next_hop(destination_hash))+" on "+str(reticulum.get_next_hop_if_name(destination_hash))
else:
more = ""

Expand All @@ -88,7 +88,7 @@ def program_setup(configdir, destination_hexhash, size=DEFAULT_PROBE_SIZE, full_
sys.stdout.flush()

hops = RNS.Transport.hops_to(destination_hash)
if hops > 1:
if hops != 1:
ms = "s"
else:
ms = ""
Expand Down
Binary file modified docs/Reticulum Manual.pdf
Binary file not shown.
7 changes: 4 additions & 3 deletions docs/manual/_sources/examples.rst.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. _examples-main:

********
Examples
********
*************
Code Examples
*************

A number of examples are included in the source distribution of Reticulum.
You can use these examples to learn how to write your own programs.

Expand Down
6 changes: 3 additions & 3 deletions docs/manual/_sources/gettingstartedfast.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ To communicate further, you will have to add one or more interfaces. The default
configuration includes a number of examples, ranging from using TCP over the
internet, to LoRa and Packet Radio interfaces.

Possibly, the examples in the config file are enough to gen you started. If
you want more information, you can read the :ref:`Interfaces<interfaces-main>`
chapter of this manual.
Possibly, the examples in the config file are enough to get you started. If
you want more information, you can read the :ref:`Building Networks<networks-main>`
and :ref:`Interfaces<interfaces-main>` chapters of this manual.


Develop a Program with Reticulum
Expand Down
6 changes: 4 additions & 2 deletions docs/manual/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,17 @@
Reticulum Network Stack Manual
******************************
This manual aims to provide you with all the information you need to
understand Reticulum, develop programs using it, or to participate in
the development of Reticulum itself.
understand Reticulum, build networks or develop programs using it, or
to participate in the development of Reticulum itself.

.. toctree::
:maxdepth: 3

whatis
gettingstartedfast
using
networks
interfaces
understanding
reference
examples
Expand Down
Loading

0 comments on commit dcde503

Please sign in to comment.