README.md update #1
15
README.md
15
README.md
@@ -1,6 +1,6 @@
|
||||
# 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**.
|
||||
|
||||
@@ -56,12 +56,14 @@ Or browse all releases on the [Releases page](https://code.igox.org/iGoX/busylig
|
||||
---
|
||||
|
||||
## Getting started
|
||||
|
||||
```bash
|
||||
flutter pub get
|
||||
flutter run
|
||||
```
|
||||
|
||||
### Run on specific platform
|
||||
|
||||
```bash
|
||||
flutter run -d iphone # iOS simulator
|
||||
open -a Simulator # open iOS simulator first if needed
|
||||
@@ -73,6 +75,7 @@ flutter run -d windows # Windows
|
||||
---
|
||||
|
||||
## Project structure
|
||||
|
||||
```
|
||||
busylight_app/
|
||||
├── 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/`.
|
||||
|
||||
### Windows — build release
|
||||
|
||||
```bash
|
||||
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)
|
||||
2. Build the release app first:
|
||||
```bash
|
||||
```bash
|
||||
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:
|
||||
```bash
|
||||
```bash
|
||||
iscc busylight-buddy-windows-installer-builder.iss
|
||||
```
|
||||
```
|
||||
|
||||
This generates a standalone `.exe` installer in the `windows/installer/` folder.
|
||||
|
||||
### App icon (all platforms)
|
||||
|
||||
Uses `flutter_launcher_icons`. Icon source: `assets/icon.png`.
|
||||
|
||||
```bash
|
||||
dart run flutter_launcher_icons
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user