Git-Mirrors/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2025-05-02 06:36:14 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated docs

Browse source
This commit is contained in:
Mark Qvist 2021-05-16 23:13:56 +02:00
parent 522204d8a5
commit cd0e177080
3 changed files with 19 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/source/examples.rst
View file

@ -6,6 +6,7 @@ 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.
.. _example-minimal:
Minimal
=======
@ -16,6 +17,8 @@ a Reticulum network from your program. In about five lines of code, you will
have the Reticulum Network Stack initialised, and ready to pass traffic in your
program.
.. _example-announce:
Announce
========
This example can be found at `<https://github.com/markqvist/Reticulum/blob/master/Examples/Announce.py>`_.
@ -24,6 +27,7 @@ The *Announce* example builds upon the previous example by exploring how to
announce a destination on the network, and how to let your program receive
notifications about announces from relevant destinations.
.. _example-broadcast:
Broadcast
=========
@ -32,6 +36,8 @@ This example can be found at `<https://github.com/markqvist/Reticulum/blob/maste
The *Broadcast* example explores how to transmit plaintext broadcast messages
over the network.
.. _example-echo:
Echo
====
This example can be found at `<https://github.com/markqvist/Reticulum/blob/master/Examples/Echo.py>`_.
@ -48,6 +54,8 @@ This example can be found at `<https://github.com/markqvist/Reticulum/blob/maste
The *Link* example explores establishing an encrypted link to a remote
destination, and passing traffic back and forth over the link.
.. _example-filetransfer:
Filetransfer
============
This example can be found at `<https://github.com/markqvist/Reticulum/blob/master/Examples/Filetransfer.py>`_.