mirror of
https://github.com/markqvist/Reticulum.git
synced 2024-11-26 23:40:18 +00:00
72 lines
2.5 KiB
Plaintext
72 lines
2.5 KiB
Plaintext
|
********************
|
||
|
|
Getting Started Fast
|
||
|
|
********************
|
||
|
|
What do we want to do? Something! When do want to do it? Right now!
|
||
|
|
|
||
|
|
The best way to get started with the Reticulum Network Stack depends on what
|
||
|
|
you want to do. This guide will outline sensible starting paths for different
|
||
|
|
scenarios.
|
||
|
|
|
||
|
|
Try Using a Reticulum-based Program
|
||
|
|
=============================================
|
||
|
|
If you simply want to try using a program built with Reticulum, you can take
|
||
|
|
a look at `Nomad Network <https://github.com/markqvist/nomadnet>`_, which
|
||
|
|
provides a basic encrypted communications suite built completely on Reticulum.
|
||
|
|
|
||
|
|
Develop a Program with Reticulum
|
||
|
|
===========================================
|
||
|
|
If you want to develop programs that use Reticulum, the easiest way to get
|
||
|
|
started is to install Reticulum via pip:
|
||
|
|
|
||
|
|
.. code::
|
||
|
|
|
||
|
|
pip3 install rns
|
||
|
|
|
||
|
|
The above command will install Reticulum and dependencies, and you will be
|
||
|
|
ready to import and use RNS in your own programs. The next step will most
|
||
|
|
likely be to look at some :ref:`Example Programs<examples-main>`.
|
||
|
|
|
||
|
|
Further information can be found in the :ref:`API Reference<api-main>`.
|
||
|
|
|
||
|
|
|
||
|
|
Participate in Reticulum Development
|
||
|
|
==============================================
|
||
|
|
If you want to participate in the development of Reticulum and associated
|
||
|
|
utilities, you'll want to get the latest source from GitHub. In that case,
|
||
|
|
don't use pip, but try this recipe:
|
||
|
|
|
||
|
|
.. code::
|
||
|
|
|
||
|
|
# Install dependencies
|
||
|
|
pip3 install cryptography pyserial
|
||
|
|
|
||
|
|
# Clone repository
|
||
|
|
git clone https://github.com/markqvist/Reticulum.git
|
||
|
|
|
||
|
|
# Move into Reticulum folder and symlink library to examples folder
|
||
|
|
cd Reticulum
|
||
|
|
ln -s ../RNS ./Examples/
|
||
|
|
|
||
|
|
# Run an example
|
||
|
|
python3 Examples/Echo.py -s
|
||
|
|
|
||
|
|
# Unless you've manually created a config file, Reticulum will do so now,
|
||
|
|
# and immediately exit. Make any necessary changes to the file:
|
||
|
|
nano ~/.reticulum/config
|
||
|
|
|
||
|
|
# ... and launch the example again.
|
||
|
|
python3 Examples/Echo.py -s
|
||
|
|
|
||
|
|
# You can now repeat the process on another computer,
|
||
|
|
# and run the same example with -h to get command line options.
|
||
|
|
python3 Examples/Echo.py -h
|
||
|
|
|
||
|
|
# Run the example in client mode to "ping" the server.
|
||
|
|
# Replace the hash below with the actual destination hash of your server.
|
||
|
|
python3 Examples/Echo.py 3e12fc71692f8ec47bc5
|
||
|
|
|
||
|
|
# Have a look at another example
|
||
|
|
python3 Examples/Filetransfer.py -h
|
||
|
|
|
||
|
|
When you have experimented with the basic examples, it's time to go read the
|
||
|
|
:ref:`Understanding Reticulum<understanding-main>` chapter.
|