orion-rf3cd9366
add installation steps and also change branch in workflows
+50 −1
2 files changed
- M .github/workflows/build-and-deploy.yml +1 −1
- M README.md +49 −0
| @@ -3,7 +3,7 @@ name: Build and Deploy Web Flasher | |||
| 3 | 3 | on: | |
| 4 | 4 | push: | |
| 5 | 5 | branches: | |
| 6 | − | - main | |
| 6 | + | - master | |
| 7 | 7 | ||
| 8 | 8 | permissions: | |
| 9 | 9 | contents: read | |
| @@ -55,4 +55,53 @@ Orion RF is a portable RF and wireless toolkit built on the ESP32 platform with | |||
| 55 | 55 | ||
| 56 | 56 | ||
| 57 | 57 | # Installation | |
| 58 | + | ## Installation | |
| 59 | + | ||
| 60 | + | ### End User Installation | |
| 61 | + | ||
| 62 | + | The easiest way to install ORION-RF is through the web installer. | |
| 63 | + | ||
| 64 | + | 1. Connect your ESP32-S3 to your computer using a USB cable. | |
| 65 | + | 2. Open the installer page: | |
| 66 | + | * https://krolyxon.github.io/orion-rf/ | |
| 67 | + | 3. Click **Connect** and select your device. | |
| 68 | + | 4. Click **Install** and wait for the flashing process to complete. | |
| 69 | + | 5. Reboot the device if required. | |
| 70 | + | ||
| 71 | + | > Google Chrome, Microsoft Edge, and other Chromium-based browsers are recommended. It may or may not work on Firefox based browsers. | |
| 72 | + | ||
| 73 | + | --- | |
| 74 | + | ||
| 75 | + | ### Development Build | |
| 76 | + | ||
| 77 | + | #### Clone the Repository | |
| 78 | + | ||
| 79 | + | ```bash | |
| 80 | + | git clone https://github.com/krolyxon/orion-rf.git | |
| 81 | + | cd orion-rf | |
| 82 | + | ``` | |
| 83 | + | ||
| 84 | + | #### Build Firmware | |
| 85 | + | ||
| 86 | + | ```bash | |
| 87 | + | pio run | |
| 88 | + | ``` | |
| 89 | + | ||
| 90 | + | Compiled binaries will be available in: | |
| 91 | + | ||
| 92 | + | ```text | |
| 93 | + | .pio/build/<environment>/ | |
| 94 | + | ``` | |
| 95 | + | ||
| 96 | + | #### Upload to Device | |
| 97 | + | ||
| 98 | + | ```bash | |
| 99 | + | pio run -t upload | |
| 100 | + | ``` | |
| 101 | + | ||
| 102 | + | #### Monitor Serial Output | |
| 103 | + | ||
| 104 | + | ```bash | |
| 105 | + | pio device monitor | |
| 106 | + | ``` | |
| 58 | 107 | ||