Git-Mirrors/reticulum_website
1
0
Fork 0
mirror of https://github.com/markqvist/reticulum_website.git synced 2024-10-01 03:15:41 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated install info

Browse Source
This commit is contained in:
Mark Qvist 2022-08-25 10:59:22 +02:00
parent 578a30d817
commit ca19f7c10d
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
source/start.md
View File

@ -7,15 +7,17 @@ you want to do. For full details and examples, have a look at the [Getting Start
## Installation
To simply install Reticulum and related utilities on your system, the easiest way is via pip:
To install Reticulum and related utilities on your system, the easiest way is via pip:
```bash
pip3 install rns
pip install rns
```
You can then start any program that uses Reticulum, or start Reticulum as a system service with [the rnsd utility](manual/using.html#the-rnsd-utility).
When first started, Reticulum will create a default configuration file, providing basic connectivity to other Reticulum peers that might be locally reachable. The default config file contains a few examples, and references for creating a more complex configuration.
If `pip` is not available on your system, install the `python3` and `python3-pip` packages for your OS first.
When first started, Reticulum will create a default configuration file, providing basic connectivity to other Reticulum peers that might be locally reachable. If any of those local peers are Transport Instances, these might connect you to wider networks. The default config file contains a few examples, and references for creating a more complex configuration.
For more detailed examples on how to expand communication over many mediums such as packet radio or LoRa, serial ports, or over fast IP links and the Internet using the UDP and TCP interfaces, take a look at the [Supported Interfaces](manual/interfaces.html) section of the [Reticulum Manual](manual/index.html).
@ -57,4 +59,4 @@ Reticulum targets a *very* wide usable performance envelope, but prioritises fun
Currently, the usable performance envelope is approximately 500 bits per second to 20 megabits per second, with physical mediums faster than that not being saturated. Performance beyond the current level is intended for future upgrades, but not highly prioritised until the wire format and API has been locked in.
<p align="right"><a href="hardware.html">Next Topic: Supported Hardware</a></p>
<p align="right"><a href="hardware.html">Next Topic: Supported Hardware</a></p>