iGoX/busylight-buddy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Releases 1 Wiki Activity

README.md update

Browse Source
This commit is contained in:
iGoX
2026-03-21 02:16:09 +01:00
parent 1efa50adb5
commit 1cb9c124c3
1 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -1,6 +1,6 @@
# BusyLight Buddy # BusyLight Buddy
Multiplatform Flutter app to control your DIY [BusyLight](https://github.com/igox/busylight) (ESP32 + MicroPython + Microdot). Multiplatform Flutter app to control your DIY [BusyLight](https://code.igox.org/iGoX/busylight) (ESP32 + MicroPython + Microdot).
Supports **iOS**, **ipadOS**, **Android**, **macOS**, and **Windows**. Supports **iOS**, **ipadOS**, **Android**, **macOS**, and **Windows**.
@@ -56,12 +56,14 @@ Or browse all releases on the [Releases page](https://code.igox.org/iGoX/busylig
--- ---
## Getting started ## Getting started
```bash ```bash
flutter pub get flutter pub get
flutter run flutter run
``` ```
### Run on specific platform ### Run on specific platform
```bash ```bash
flutter run -d iphone # iOS simulator flutter run -d iphone # iOS simulator
open -a Simulator # open iOS simulator first if needed open -a Simulator # open iOS simulator first if needed
@@ -73,6 +75,7 @@ flutter run -d windows # Windows
--- ---
## Project structure ## Project structure
``` ```
busylight_app/ busylight_app/
├── assets/ ├── assets/
@@ -142,6 +145,7 @@ Two helper scripts are available in the `android/` folder to build and rename th
Both scripts build the APK with `flutter build apk`, then rename the output from `app-<type>.apk` to `org.igox.apps.android.busylight-buddy-<type>.apk` (and its `.sha1` file if present) in `build/app/outputs/flutter-apk/`. Both scripts build the APK with `flutter build apk`, then rename the output from `app-<type>.apk` to `org.igox.apps.android.busylight-buddy-<type>.apk` (and its `.sha1` file if present) in `build/app/outputs/flutter-apk/`.
### Windows — build release ### Windows — build release
```bash ```bash
flutter build windows --release flutter build windows --release
``` ```
@@ -152,19 +156,20 @@ The repository includes an [Inno Setup](https://jrsoftware.org/isdl.php) configu
1. Download and install [Inno Setup](https://jrsoftware.org/isdl.php) 1. Download and install [Inno Setup](https://jrsoftware.org/isdl.php)
2. Build the release app first: 2. Build the release app first:
```bash ```bash
flutter build windows --release flutter build windows --release
``` ```
3. Open `busylight-buddy-windows-installer-builder.iss` in Inno Setup Compiler and click **Compile**, or run from the command line: 3. Open `busylight-buddy-windows-installer-builder.iss` in Inno Setup Compiler and click **Compile**, or run from the command line:
```bash ```bash
iscc busylight-buddy-windows-installer-builder.iss iscc busylight-buddy-windows-installer-builder.iss
``` ```
This generates a standalone `.exe` installer in the `windows/installer/` folder. This generates a standalone `.exe` installer in the `windows/installer/` folder.
### App icon (all platforms) ### App icon (all platforms)
Uses `flutter_launcher_icons`. Icon source: `assets/icon.png`. Uses `flutter_launcher_icons`. Icon source: `assets/icon.png`.
```bash ```bash
dart run flutter_launcher_icons dart run flutter_launcher_icons
``` ```