]> git.tnoah.ca Git - lora-radio.git/commitdiff
Update README.md
authormarkqvist <mark@unsigned.io>
Tue, 1 Nov 2022 22:22:32 +0000 (23:22 +0100)
committerGitHub <noreply@github.com>
Tue, 1 Nov 2022 22:22:32 +0000 (23:22 +0100)
README.md

index aab119f4c94de559de989bb96f553f6fe28b5a1d..f1925ddc111317b25b68de015e76d1cf9dddbeb8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,6 +13,18 @@ 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).
 
+## Get Started
+
+You can download and flash the firmware to all the supported boards using the [RNode Config Utility](https://github.com/markqvist/rnodeconfigutil). All firmware releases are now handled and installed directly through the `rnodeconf` utility, 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
+```
+
 ## Current Status
 The RNode firmware can be considered stable at this point. If you do find a bug or discover unintended behaviour, please report it as an issue here, so I can fix it!