update readme
This commit is contained in:
23
README.md
23
README.md
@@ -8,7 +8,6 @@ A modern, high-contrast **KDE Plasma System Tray Uploader** and desktop integrat
|
||||
|
||||
- **System Tray App with Live Progress**: Dynamic system tray icon displaying live upload percentage (`0`–`99`%).
|
||||
- **Single-Instance IPC Architecture**: 100% Python-based daemon (`PySide6`). Multiple invocations (hotkeys, Dolphin context menu) delegate directly to the running tray instance without spawning duplicates.
|
||||
- **Black Sun Branding & Themes**: Features sharp "Black Sun" graphics with a choice between Dark and Light tray themes, plus a solid white-background Start Menu launcher icon.
|
||||
- **Dolphin Context Menu Integration**: Right-click any file in Dolphin -> **Actions** -> **Upload to f0ckm**.
|
||||
- **Spectacle Screenshot Capture**: Region capture integration via hotkeys or menu trigger (`kde-uploader-gui --spectacle`).
|
||||
- **Smart Notification Previews**:
|
||||
@@ -24,11 +23,11 @@ A modern, high-contrast **KDE Plasma System Tray Uploader** and desktop integrat
|
||||
Ensure the following system dependencies are installed:
|
||||
|
||||
| Dependency | Purpose | Recommended Package (Fedora / Arch / Ubuntu) |
|
||||
| :--- | :--- | :--- |
|
||||
| :---------------------- | :------------------------- | :------------------------------------------- |
|
||||
| **Python 3.9+** | Execution Runtime | `python3` |
|
||||
| **PySide6** | GUI Framework & IPC | `python3-pyside6` or `pip install PySide6` |
|
||||
| **Spectacle** | Region Screenshot Capture | `spectacle` (KDE Utility) |
|
||||
| **ffmpeg** *(Optional)* | Video Thumbnail Generation | `ffmpeg` |
|
||||
| **ffmpeg** _(Optional)_ | Video Thumbnail Generation | `ffmpeg` |
|
||||
| **libnotify** | Desktop Notifications | `libnotify` (`notify-send`) |
|
||||
|
||||
---
|
||||
@@ -36,39 +35,48 @@ Ensure the following system dependencies are installed:
|
||||
## Quick Setup & Installation
|
||||
|
||||
### 1. Clone the Repository
|
||||
|
||||
```bash
|
||||
git clone https://git.lat/kibi/f0ckm-uploader
|
||||
cd f0ckm-uploader
|
||||
```
|
||||
|
||||
### 2. Install Python Dependencies
|
||||
|
||||
```bash
|
||||
pip install PySide6
|
||||
```
|
||||
*(Or install via system package manager: `sudo dnf install python3-pyside6` / `sudo apt install python3-pyside6`)*
|
||||
|
||||
### 3. Environment Configuration *(Optional)*
|
||||
_(Or install via system package manager: `sudo dnf install python3-pyside6` / `sudo apt install python3-pyside6`)_
|
||||
|
||||
### 3. Environment Configuration _(Optional)_
|
||||
|
||||
You can set up a `.env` file prior to installation, or configure settings later via the GUI:
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
Edit `.env`:
|
||||
|
||||
```env
|
||||
API_URL=https://your-f0ckm-instance.com/api/v2/upload
|
||||
API_KEY=your_secret_api_key
|
||||
DEFAULT_RATING=s
|
||||
DEFAULT_TAGS=screenshot
|
||||
DEFAULT_TAGS=
|
||||
DEFAULT_VISIBILITY=0
|
||||
DEFAULT_IS_OC=false
|
||||
```
|
||||
|
||||
### 4. Run the Installer
|
||||
|
||||
```bash
|
||||
chmod +x install.sh
|
||||
./install.sh
|
||||
```
|
||||
|
||||
The installer will automatically:
|
||||
|
||||
1. Copy binaries to `~/.local/bin/kde-uploader-gui` and `~/.local/bin/kde-uploader`.
|
||||
2. Generate multi-resolution icons (`32x32`, `48x48`, `64x64`, `128x128`, `256x256`) for KRunner & Start Menu compatibility.
|
||||
3. Register the Dolphin context menu action in `~/.local/share/kio/servicemenus/`.
|
||||
@@ -91,6 +99,7 @@ To bind a keyboard shortcut to capture a screen region and upload it immediately
|
||||
## Usage
|
||||
|
||||
### System Tray
|
||||
|
||||
- **Single Click**: Triggers region screenshot capture & upload.
|
||||
- **Right Click**: Opens context menu for:
|
||||
- **Capture Region & Upload**
|
||||
@@ -101,9 +110,11 @@ To bind a keyboard shortcut to capture a screen region and upload it immediately
|
||||
- **Double Click**: Opens the Settings dialog.
|
||||
|
||||
### Dolphin File Manager
|
||||
|
||||
- Right-click any file -> **Actions** -> **Upload to f0ckm**.
|
||||
|
||||
### Command Line Interface (CLI)
|
||||
|
||||
```bash
|
||||
# Capture screen region and upload
|
||||
kde-uploader-gui --spectacle
|
||||
|
||||
Reference in New Issue
Block a user