🐛 Include gitmojis in build
This commit is contained in:
18
README.md
18
README.md
@@ -9,6 +9,7 @@ A fast and efficient C++ implementation of the Gitmoji picker for Albert launche
|
||||
- Configurable copy format via settings
|
||||
- Fast indexing and fuzzy search
|
||||
- Native Albert C++ plugin
|
||||
- Gitmoji data embedded as Qt resource (no external files needed)
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -26,12 +27,14 @@ Copy the built library to your Albert plugins directory:
|
||||
|
||||
```bash
|
||||
# Local installation
|
||||
cp build/libgitmoji.so ~/.local/lib/albert/
|
||||
cp build/gitmoji.so ~/.local/lib/albert/
|
||||
|
||||
# Or system-wide
|
||||
sudo cp build/libgitmoji.so /usr/lib/albert/
|
||||
sudo cp build/gitmoji.so /usr/lib/albert/
|
||||
```
|
||||
|
||||
Restart Albert to load the plugin.
|
||||
|
||||
## Usage
|
||||
|
||||
Trigger the plugin with `gm ` followed by your search query.
|
||||
@@ -43,17 +46,20 @@ Examples:
|
||||
|
||||
## Configuration
|
||||
|
||||
Access the plugin settings in Albert to choose what to copy:
|
||||
- **Emoji**: Copy the emoji character (e.g., 🎨)
|
||||
- **Gitmoji code**: Copy the code (e.g., :art:)
|
||||
Access plugin settings in Albert to choose what to copy:
|
||||
- **Emoji**: Copy emoji character (e.g., 🎨)
|
||||
- **Gitmoji code**: Copy code (e.g., :art:)
|
||||
|
||||
Settings are persisted using QSettings.
|
||||
|
||||
## Development
|
||||
|
||||
This plugin uses:
|
||||
- Albert C++ API
|
||||
- Qt6 framework
|
||||
- Qt6 framework with embedded resources
|
||||
- CMake build system
|
||||
- IndexQueryHandler for efficient search
|
||||
- BackgroundExecutor for async indexing
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Reference in New Issue
Block a user