From 3cd93660a3eee2ca9a1afbbcc7c64c362bbda108 Mon Sep 17 00:00:00 2001 From: krolyxon Date: Mon, 8 Jun 2026 22:40:57 +0530 Subject: add installation steps and also change branch in workflows --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 8a743f7..0120cdd 100644 --- a/README.md +++ b/README.md @@ -55,4 +55,53 @@ Orion RF is a portable RF and wireless toolkit built on the ESP32 platform with # Installation +## Installation + +### End User Installation + +The easiest way to install ORION-RF is through the web installer. + +1. Connect your ESP32-S3 to your computer using a USB cable. +2. Open the installer page: + * https://krolyxon.github.io/orion-rf/ +3. Click **Connect** and select your device. +4. Click **Install** and wait for the flashing process to complete. +5. Reboot the device if required. + +> Google Chrome, Microsoft Edge, and other Chromium-based browsers are recommended. It may or may not work on Firefox based browsers. + +--- + +### Development Build + +#### Clone the Repository + +```bash +git clone https://github.com/krolyxon/orion-rf.git +cd orion-rf +``` + +#### Build Firmware + +```bash +pio run +``` + +Compiled binaries will be available in: + +```text +.pio/build// +``` + +#### Upload to Device + +```bash +pio run -t upload +``` + +#### Monitor Serial Output + +```bash +pio device monitor +``` -- cgit v1.2.3