Mirror/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2026-07-08 09:38:11 -07:00
Code Issues Packages Projects Releases Wiki Activity

Added markdown manual build

Browse Source
This commit is contained in:
Mark Qvist
2026-05-06 21:18:01 +02:00
parent 4d6e164d62
commit ec27d8bfde
18 changed files with 1025 additions and 166 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/markdown/examples.md
+1 -23
View File
@@ -1,12 +1,8 @@
<a id="examples-main"></a>
# 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.
<a id="example-minimal"></a>
## Minimal
The *Minimal* example demonstrates the bare-minimum setup required to connect to
@@ -121,8 +117,6 @@ if __name__ == "__main__":
This example can also be found at [https://github.com/markqvist/Reticulum/blob/master/Examples/Minimal.py](https://github.com/markqvist/Reticulum/blob/master/Examples/Minimal.py).
<a id="example-announce"></a>
## Announce
The *Announce* example builds upon the previous example by exploring how to
@@ -306,8 +300,6 @@ if __name__ == "__main__":
This example can also be found at [https://github.com/markqvist/Reticulum/blob/master/Examples/Announce.py](https://github.com/markqvist/Reticulum/blob/master/Examples/Announce.py).
<a id="example-broadcast"></a>
## Broadcast
The *Broadcast* example explores how to transmit plaintext broadcast messages
@@ -439,8 +431,6 @@ if __name__ == "__main__":
This example can also be found at [https://github.com/markqvist/Reticulum/blob/master/Examples/Broadcast.py](https://github.com/markqvist/Reticulum/blob/master/Examples/Broadcast.py).
<a id="example-echo"></a>
## Echo
The *Echo* example demonstrates communication between two destinations using
@@ -783,8 +773,6 @@ if __name__ == "__main__":
This example can also be found at [https://github.com/markqvist/Reticulum/blob/master/Examples/Echo.py](https://github.com/markqvist/Reticulum/blob/master/Examples/Echo.py).
<a id="example-link"></a>
## Link
The *Link* example explores establishing an encrypted link to a remote
@@ -1085,8 +1073,6 @@ if __name__ == "__main__":
This example can also be found at [https://github.com/markqvist/Reticulum/blob/master/Examples/Link.py](https://github.com/markqvist/Reticulum/blob/master/Examples/Link.py).
<a id="example-identify"></a>
## Identification
The *Identify* example explores identifying an intiator of a link, once
@@ -1410,8 +1396,6 @@ if __name__ == "__main__":
This example can also be found at [https://github.com/markqvist/Reticulum/blob/master/Examples/Identify.py](https://github.com/markqvist/Reticulum/blob/master/Examples/Identify.py).
<a id="example-request"></a>
## Requests & Responses
The *Request* example explores sending requests and receiving responses.
@@ -1707,8 +1691,6 @@ if __name__ == "__main__":
This example can also be found at [https://github.com/markqvist/Reticulum/blob/master/Examples/Request.py](https://github.com/markqvist/Reticulum/blob/master/Examples/Request.py).
<a id="example-channel"></a>
## Channel
The *Channel* example explores using a `Channel` to send structured
@@ -2440,8 +2422,6 @@ if __name__ == "__main__":
This example can also be found at [https://github.com/markqvist/Reticulum/blob/master/Examples/Buffer.py](https://github.com/markqvist/Reticulum/blob/master/Examples/Buffer.py).
<a id="example-filetransfer"></a>
## Filetransfer
The *Filetransfer* example implements a basic file-server program that
@@ -3056,8 +3036,6 @@ if __name__ == "__main__":
This example can also be found at [https://github.com/markqvist/Reticulum/blob/master/Examples/Filetransfer.py](https://github.com/markqvist/Reticulum/blob/master/Examples/Filetransfer.py).
<a id="example-custominterface"></a>
## Custom Interfaces
The *ExampleInterface* demonstrates creating custom interfaces for Reticulum.
@@ -3365,4 +3343,4 @@ class ExampleInterface(Interface):
interface_class = ExampleInterface
```
This example can also be found at [https://github.com/markqvist/Reticulum/blob/master/Examples/ExampleInterface.py](https://github.com/markqvist/Reticulum/blob/master/Examples/ExampleInterface.py).
This example can also be found at [https://github.com/markqvist/Reticulum/blob/master/Examples/ExampleInterface.py](https://github.com/markqvist/Reticulum/blob/master/Examples/ExampleInterface.py).