diff --git a/README b/README deleted file mode 100644 index 4d779eb..0000000 --- a/README +++ /dev/null @@ -1,5 +0,0 @@ -# Qortal RNS - -Comprehensive setup of a Reticulum Network Stack. -Integrate it with the Qortal API (and potentially others). - diff --git a/README.md b/README.md new file mode 100644 index 0000000..51e63b2 --- /dev/null +++ b/README.md @@ -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 ... +```