From 100d2986bcde0540e3d727b8579919b5f3d04c00 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Thu, 10 Nov 2022 11:52:13 +0100 Subject: [PATCH] Updated readme --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d2c630e..ba5971e 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ This is the firmware for [RNode](https://unsigned.io/rnode), a very flexible LoR To install this firmware on homebrew RNodes and other supported boards, please use the [RNode Config Utility](https://github.com/markqvist/rnodeconfigutil). It contains an auto-installer that allows you to install the RNode firmware on a variety of boards. For guides and tutorials on how to get started with making your own RNodes, visit [unsigned.io](https://unsigned.io). -## Supported Hardware +## Installation & Supported Hardware The RNode Firmware supports the following boards: @@ -26,7 +26,15 @@ The RNode Firmware supports the following boards: - LilyGO LoRa32 v2.1 devices - Heltec LoRa32 v2 devices -For configuring an RNode with this firmware, please have a look at the [RNode Config Utility](https://github.com/markqvist/rnodeconfigutil). +You can download and flash the firmware to supported boards using `rnodeconf`, the *RNode Config Utility*. All firmware releases are handled and installed directly through `rnodeconf`, which is inclueded in the `rns` package. It can be installed via `pip`: + +``` +# Install rnodeconf via rns package +pip install rns --upgrade + +# Install the firmware on a board with the install guide +rnodeconf --autoinstall +``` ## Operating Modes RNode can operate in two modes, host-controlled (default) and TNC mode: