rename and add prerequisites

This commit is contained in:
Jürg Schulthess 2024-08-23 08:00:43 +02:00
parent 99b8bfe19b
commit c7ca69074a
2 changed files with 28 additions and 5 deletions

5
README
View File

@ -1,5 +0,0 @@
# Qortal RNS
Comprehensive setup of a Reticulum Network Stack.
Integrate it with the Qortal API (and potentially others).

28
README.md Normal file
View File

@ -0,0 +1,28 @@
# Qortal RNS
Comprehensive setup of a Reticulum Network Stack.
Integrate it with the Qortal API (and potentially others).
## Prerequisites
```shell
# install python3 for your OS. Eg. Ubuntu
apt install -y python3.10-venv
# create virtual environment
python3 -m venv ~/rns
source ~/rns/bin/activate
# (optional) add it to the bash profile
echo "source ~/rns/bin/activate" >> .bashrc
# install requirements (ansible, rns, ...)
pip install -r requirements.txt
```
## Setup RNS
```shell
# config user startup and default config
ansible-playbook ...
```