diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..646d7e625bc81e559f57ad8e21e76183fcb635e0 --- /dev/null +++ b/README.en.md @@ -0,0 +1,42 @@ +# Sitting Reminder App + +A timer reminder application that runs in the system tray, helping users stand up and move during work breaks to protect their health. + +## Features + +- **Timed Reminders** - Customize reminder intervals with automatic prompts +- **System Tray** - Lightweight system tray application that doesn't occupy taskbar space +- **Desktop Notifications** - Supports system-level notification alerts +- **Simple UI** - Minimalist reminder dialog for intuitive usability + +## System Requirements + +- Rust 1.56+ +- Linux desktop environment (with system tray support) + +## Build and Run + +```bash +# Build +cargo build --release + +# Run +cargo run --release +``` + +## Usage Instructions + +1. After launching, the application will display an icon in the system tray +2. Click the tray icon to access settings or exit +3. When the set time is reached, a reminder dialog will pop up +4. Users can configure the reminder interval + +## Dependencies + +- `ksni` - System tray support +- `tokio` - Async runtime +- Other runtime dependencies are listed in Cargo.toml + +## Open Source License + +This project is open-sourced under the MIT License. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..0ab26a6176eb71f6ebb5466070944efb951dd3dc --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ + + +基于提供的代码地图,我可以了解到这是一个使用Rust编写的系统托盘久坐提醒应用程序。根据项目结构和Git仓库URL(来自Gitee),文档应该使用中文。 + +根据代码地图中的结构分析: +- `ReminderState` - 提醒状态管理结构 +- `TrayAction` - 托盘操作枚举 +- `TrayService` - 系统托盘服务实现 +- `ksni::Tray` - 系统托盘trait实现 +- `show_notification()` - 显示通知 +- `show_reminder_dialog()` - 显示提醒对话框 +- `format_time()` - 时间格式化 +- `build_ui()` - 构建用户界面 + +这是一个典型的桌面久坐提醒应用,通过系统托盘运行,定时提醒用户起身活动。 + +--- + +# 久坐提醒应用 + +一款运行在系统托盘的定时提醒应用,帮助用户在工作间隙起身活动,保护身体健康。 + +## 功能特点 + +- **定时提醒** - 自定义提醒间隔,到时自动提示 +- **系统托盘** - 轻量级系统托盘应用,不占用任务栏空间 +- **桌面通知** - 支持系统通知提醒 +- **简洁UI** - 简单的提醒对话框,直观易用 + +## 环境要求 + +- Rust 1.56+ +- Linux桌面环境 (支持系统托盘) + +## 编译运行 + +```bash +# 编译 +cargo build --release + +# 运行 +cargo run --release +``` + +## 使用说明 + +1. 应用启动后会在系统托盘区域显示图标 +2. 点击托盘图标可进行设置或退出 +3. 到达设定时间后会弹出提醒对话框 +4. 用户可以设置提醒间隔时间 + +## 依赖项 + +- `ksni` - 系统托盘支持 +- `tokio` - 异步运行时 +- 其他运行时依赖见 Cargo.toml + +## 开源许可 + +本项目基于 MIT 许可证开源。 \ No newline at end of file