From 1efa50adb5a60490a33cff444cfaf14bf30fc836 Mon Sep 17 00:00:00 2001 From: iGoX Date: Sat, 21 Mar 2026 02:10:25 +0100 Subject: [PATCH] README.md update --- .gitignore | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ .metadata | 30 ++++++++++++++++++++++++++++++ README.md | 19 +++++++------------ 3 files changed, 88 insertions(+), 12 deletions(-) create mode 100644 .gitignore create mode 100644 .metadata diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ca2178b --- /dev/null +++ b/.gitignore @@ -0,0 +1,51 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.build/ +.buildlog/ +.history +.svn/ +.swiftpm/ +migrate_working_dir/ + +# IntelliJ related +*.iml +*.ipr +*.iws +.idea/ + +# The .vscode folder contains launch configuration and tasks you configure in +# VS Code which you may wish to be included in version control, so this line +# is commented out by default. +#.vscode/ + +# Flutter/Dart/Pub related +**/doc/api/ +**/ios/Flutter/.last_build_id +.dart_tool/ +.flutter-plugins-dependencies +.pub-cache/ +.pub/ +/build/ +/coverage/ + +# Symbolication related +app.*.symbols + +# Obfuscation related +app.*.map.json + +# Android Studio will place build artifacts here +/android/app/debug +/android/app/profile +/android/app/release + +.flutter-plugins-dependencies +android/key.properties +windows/installer/* +bugreport* +!downloads/* \ No newline at end of file diff --git a/.metadata b/.metadata new file mode 100644 index 0000000..2945207 --- /dev/null +++ b/.metadata @@ -0,0 +1,30 @@ +# This file tracks properties of this Flutter project. +# Used by Flutter tool to assess capabilities and perform upgrades etc. +# +# This file should be version controlled and should not be manually edited. + +version: + revision: "2c9eb20739dfec95e2c74bd3dfa4601b0a8a36aa" + channel: "stable" + +project_type: app + +# Tracks metadata for the flutter migrate command +migration: + platforms: + - platform: root + create_revision: 2c9eb20739dfec95e2c74bd3dfa4601b0a8a36aa + base_revision: 2c9eb20739dfec95e2c74bd3dfa4601b0a8a36aa + - platform: windows + create_revision: 2c9eb20739dfec95e2c74bd3dfa4601b0a8a36aa + base_revision: 2c9eb20739dfec95e2c74bd3dfa4601b0a8a36aa + + # User provided section + + # List of Local paths (relative to this file) that should be + # ignored by the migrate tool. + # + # Files that are not part of the templates will be ignored by default. + unmanaged_files: + - 'lib/main.dart' + - 'ios/Runner.xcodeproj/project.pbxproj' diff --git a/README.md b/README.md index d1965b4..02cc330 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,10 @@ Supports **iOS**, **ipadOS**, **Android**, **macOS**, and **Windows**. ## Downloads -[![Windows](https://img.shields.io/badge/Windows-Installer-0078D4?style=for-the-badge&logo=windows&logoColor=white)](https://github.com/igox/busylight-buddy/releases/download/v0.0.1/BusyLight-Buddy-Installer.exe) -[![Android](https://img.shields.io/badge/Android-APK-3DDC84?style=for-the-badge&logo=android&logoColor=white)](https://github.com/igox/busylight-buddy/releases/download/v0.0.1/org.igox.apps.android.busylight-buddy-release.apk) +[![Windows](https://img.shields.io/badge/Windows-Installer-0078D4?style=for-the-badge&logo=windows&logoColor=white)](https://code.igox.org/iGoX/busylight-buddy/releases/download/v0.0.1/BusyLight-Buddy-Installer.exe) +[![Android](https://img.shields.io/badge/Android-APK-3DDC84?style=for-the-badge&logo=android&logoColor=white)](https://code.igox.org/iGoX/busylight-buddy/releases/download/v0.0.1/org.igox.apps.android.busylight-buddy-release.apk) -Or browse all releases on the [Releases page](https://github.com/igox/busylight-buddy/releases). +Or browse all releases on the [Releases page](https://code.igox.org/iGoX/busylight-buddy/releases). --- @@ -56,14 +56,12 @@ Or browse all releases on the [Releases page](https://github.com/igox/busylight- --- ## 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 @@ -75,7 +73,6 @@ flutter run -d windows # Windows --- ## Project structure - ``` busylight_app/ ├── assets/ @@ -145,7 +142,6 @@ 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-.apk` to `org.igox.apps.android.busylight-buddy-.apk` (and its `.sha1` file if present) in `build/app/outputs/flutter-apk/`. ### Windows — build release - ```bash flutter build windows --release ``` @@ -156,20 +152,19 @@ 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 ```