diff options
| author | krolyxon <me@krolyxon.com> | 2026-06-08 22:40:57 +0530 |
|---|---|---|
| committer | krolyxon <me@krolyxon.com> | 2026-06-08 22:40:57 +0530 |
| commit | 3cd93660a3eee2ca9a1afbbcc7c64c362bbda108 (patch) | |
| tree | 97b0a2f5407196dc5a66c99eef37a99576537c6c | |
| parent | b90b435a12cf597fd0d9fbf4ad4942b45d816f6d (diff) | |
add installation steps and also change branch in workflows
| -rw-r--r-- | .github/workflows/build-and-deploy.yml | 2 | ||||
| -rw-r--r-- | README.md | 49 |
2 files changed, 50 insertions, 1 deletions
diff --git a/.github/workflows/build-and-deploy.yml b/.github/workflows/build-and-deploy.yml index 08eecef..d86a4c1 100644 --- a/.github/workflows/build-and-deploy.yml +++ b/.github/workflows/build-and-deploy.yml @@ -3,7 +3,7 @@ name: Build and Deploy Web Flasher on: push: branches: - - main + - master permissions: contents: read @@ -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/<environment>/ +``` + +#### Upload to Device + +```bash +pio run -t upload +``` + +#### Monitor Serial Output + +```bash +pio device monitor +``` |
