-
Notifications
You must be signed in to change notification settings - Fork 246
fix: Updated the Readme #1511
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: Updated the Readme #1511
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Build StatusBuild successful. APKs to test: https://github.com/fossasia/badgemagic-app/actions/runs/19138963285/artifacts/4488049765. Screenshots |
|
@nope3472 Add compatibility for windows and macos too. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR significantly expands the README documentation with comprehensive feature descriptions, usage guides, and platform information to better inform potential users about the Badge Magic app's capabilities.
- Replaced brief introductory paragraph with detailed feature documentation organized into 7 themed sections (Multi-Mode Creation, Animation & Effects, Badge Management, Drawing Tools, User Interface, Advanced Features)
- Added "How It Works" section with step-by-step guides for creating badges, drawing, badge management, and Bluetooth transfer
- Added "Supported Platforms" section documenting Android, iOS, and Linux support, and reorganized permissions information with clearer descriptions
- Added "App Interface Overview" and "Key Screens" sections describing the tabbed interface and main application screens
- Removed "Translations" section (Weblate reference)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Key Features | ||
|
|
||
| ### 🎨 **Multi-Mode Creation** | ||
| - **Text Mode**: Create animated text with 22 different transition effects |
Copilot
AI
Nov 6, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inconsistent count: Line 16 states "22 different transition effects" but line 22 lists "22 Animation Types". In line 16, the term should be "animation types" or "animations" rather than "transition effects" to maintain consistency with the detailed description in line 22.
| - **Text Mode**: Create animated text with 22 different transition effects | |
| - **Text Mode**: Create animated text with 22 different animation types |
| ## How It Works | ||
|
|
||
| ### Creating Badges | ||
| 1. **Text Creation**: Enter your message in the text field and choose from 22 different animations |
Copilot
AI
Nov 6, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inconsistent animation count: This line claims "choose from 22 different animations" but this conflicts with line 138 which states only 5 basic text animations are available in the Transition Tab (Left, Right, Up, Down, Fixed). The 22 animations mentioned in line 22 include both basic and advanced animations across multiple tabs. Consider clarifying that 22 animations are available across all tabs, not just for text creation.
| 1. **Text Creation**: Enter your message in the text field and choose from 22 different animations | |
| 1. **Text Creation**: Enter your message in the text field and choose from 5 basic text animations (Left, Right, Up, Down, Fixed) in the Transition Tab. Advanced animations (totaling 22 across all tabs) are available via other modes for further customization. |
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>







-1_home_screen.png?raw=true)
-2_text_badge.png?raw=true)
-3_emoji_badge.png?raw=true)
-4_inverted_emoji_badge.png?raw=true)
-5_saved_badges.png?raw=true)
-6_saved_badges_clicked.png?raw=true)
-7_draw_badge.png?raw=true)
Fixes #1429
Changes
Screenshots / Recordings
Checklist:
constants.dartwithout hard coding any value.