-
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
Changes from all commits
7f41ce6
360374d
6abc751
7ad59c5
7a9345e
8e60e04
2e0ffbb
677c8dc
a2f5dde
0faec13
93b443b
c7ef0ec
4e8a3ca
68a9293
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -8,7 +8,73 @@ | |||||
|
|
||||||
| **Magically Create Text and Draw Cliparts on LED Name Badges using Bluetooth** | ||||||
|
|
||||||
| The Badge Magic Android app lets you create moving text and draw clipart for LED name badges. The app provides options to portray names, cliparts, and simple animations on the badges. For the org.fossasia.badgemagic.data transfer from the smartphone to the LED badge it uses Bluetooth. The project is based on the work of [Nilhcem](https://github.com/Nilhcem). | ||||||
| The Badge Magic app is a comprehensive LED badge management system that lets you create, customize, save, and transfer dynamic text and graphics to LED name badges via Bluetooth. The app features an intuitive interface with multiple creation modes, extensive animation options, and powerful customization tools. | ||||||
|
|
||||||
| ## Key Features | ||||||
|
|
||||||
| ### 🎨 **Multi-Mode Creation** | ||||||
| - **Text Mode**: Create animated text with 22 different transition effects | ||||||
| - **Draw Mode**: Freehand drawing with shape tools (square, rectangle, circle, triangle) | ||||||
| - **Clipart Mode**: Import and use pre-made graphics | ||||||
| - **Animation Mode**: Advanced animations including Pacman, hearts, fireworks, and more | ||||||
|
|
||||||
| ### 🎭 **Animation & Effects** | ||||||
| - **22 Animation Types**: Left, Right, Up, Down, Fixed, Snowflake, Picture, Laser, Pacman, Chevron, Diamond, Broken Hearts, Cupid, Feet, Fish, Diagonal, Emergency, Beating Hearts, Fireworks, Digital Rain (Equalizer), and Cycle | ||||||
| - **3 Visual Effects**: Flash, Invert, and Marquee | ||||||
| - **Speed Control**: 8-speed radial dial for precise animation timing | ||||||
| - **Transition Tab**: Quick access to basic animations | ||||||
|
|
||||||
| ### 💾 **Badge Management** | ||||||
| - **Save & Edit**: Save badges with original text preservation for easy editing | ||||||
| - **Custom Slot Decider**: Select up to 8 badges for batch operations | ||||||
| - **Import/Export**: Share badges between devices | ||||||
| - **Badge Library**: Organized collection of saved creations | ||||||
|
|
||||||
| ### 🎯 **Drawing Tools** | ||||||
| - **Shape Tools**: Freehand, Square, Rectangle, Circle, Triangle | ||||||
| - **Undo/Redo**: Full drawing history support | ||||||
| - **Grid-Based**: Precise 11×44 LED grid editing | ||||||
| - **Real-time Preview**: See changes as you draw | ||||||
|
|
||||||
| ### 📱 **User Interface** | ||||||
| - **4 Main Tabs**: Speed, Transition, Effects, and Animation | ||||||
| - **Multi-language Support**: English and Hindi | ||||||
| - **Settings Screen**: Bluetooth device management and scan preferences | ||||||
| - **Navigation Drawer**: Easy access to all features | ||||||
|
|
||||||
| ### 🔧 **Advanced Features** | ||||||
| - **Bluetooth Alias Management**: Rename and manage connected devices | ||||||
| - **Scan Settings**: Configure device discovery preferences | ||||||
| - **Cross-Platform Support**: Works on Android, iOS, and Linux (mobile and desktop platforms) | ||||||
|
|
||||||
| The project is based on the work of [Nilhcem](https://github.com/Nilhcem) and has been significantly expanded with modern features and improved user experience. | ||||||
|
|
||||||
| ## How It Works | ||||||
|
|
||||||
| ### Creating Badges | ||||||
| 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 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. |
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.