From 15f3428e0c3347f6ddaff0fe8356535002bc6903 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Thu, 10 Jul 2025 16:16:39 +0000 Subject: [PATCH] Update README.md --- README.en.md | 84 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 84 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 168 insertions(+) create mode 100644 README.en.md create mode 100644 README.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..17a99fb --- /dev/null +++ b/README.en.md @@ -0,0 +1,84 @@ + + +# easy-desktop + +A clean and beautiful desktop file management tool that provides quick access, file management, icon preview, and other features. + +## Features + +- Quick access to frequently used folders +- Switch between file list and grid view +- Support for drag-and-drop operations +- File search and path navigation +- Customizable theme settings +- Icon preview support for common file types +- Context menu operations (open/copy/rename/delete/create) +- Window animation effects + +## Technology Stack + +- Python + PyQt5 (interface and logic) +- HTML/CSS (front-end interface design) +- FontAwesome (icon library) +- Custom easing animations + +## Installation + +1. Ensure Python 3.7+ is installed +2. Install dependencies: `pip install pyqt5` +3. Run the main program: `python easyDesktop.py` + +## Usage Instructions + +### Main Interface +- Top-left corner displays the current time +- Central area shows the file list (grid/list view) +- Top-right corner provides path navigation and a search box +- Supports switching between dark and light themes + +### File Operations +Right-click on a file to: +- Open file +- Copy file +- Rename file +- Delete file + +Right-click on an empty area to: +- Paste file +- Create new file + +### Theme Settings +Through the settings panel, you can switch: +- Dark/Light themes +- Customize interface element styles + +## Code Structure + +### Python Modules +- File management: `get_desktop_path`, `open_file`, `copy_file`, `rename_file`, `remove_file`, `new_file` +- Window animation: `animate_window`, `ease_out_quad` +- Icon processing: `get_icon`, `match_ico` +- Configuration management: `update_inf`, `on_loaded` + +### HTML Structure +- Main container: `.container` +- File list: `#filesContainer`, `#filesListContainer` +- Context menu: `#contextMenu`, `#blankMenu` +- Operation panels: Containers for rename/delete/create/theme settings + +### Style Files +- `all.min.css`: FontAwesome icon styles +- `dark.css`/`light.css`/`zzz.css`: Different theme style sheets +- BEM naming convention is used + +## Contribution Guide + +1. Clone the repository: `git clone https://gitee.com/codevicent/easy-desktop` +2. Create a branch: `git checkout -b feature/your-feature` +3. Commit changes: `git commit -m 'Add some feature'` +4. Push the branch: `git push origin feature/your-feature` +5. Submit a Pull Request + +## License + +This project uses the MIT License. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..8578524 --- /dev/null +++ b/README.md @@ -0,0 +1,84 @@ + + +# easy-desktop + +一个简洁美观的桌面文件管理工具,提供快速访问、文件管理、图标预览等功能。 + +## 功能特色 + +- 快速访问常用文件夹 +- 文件列表与网格视图切换 +- 拖放操作支持 +- 文件搜索与路径导航 +- 自定义主题设置 +- 支持常见文件类型图标预览 +- 右键菜单操作(打开/复制/重命名/删除/新建) +- 窗口动画效果 + +## 技术栈 + +- Python + PyQt5 (界面与逻辑) +- HTML/CSS (前端界面设计) +- FontAwesome (图标库) +- 自定义缓动动画 + +## 安装 + +1. 确保已安装 Python 3.7+ +2. 安装依赖: `pip install pyqt5` +3. 运行主程序: `python easyDesktop.py` + +## 使用说明 + +### 主界面 +- 左上角显示当前时间 +- 中央区域展示文件列表(网格/列表视图) +- 右上角提供路径导航与搜索框 +- 支持切换深色/浅色主题 + +### 文件操作 +右键文件可进行: +- 打开文件 +- 复制文件 +- 重命名文件 +- 删除文件 + +空白区域右键可: +- 粘贴文件 +- 新建文件 + +### 主题设置 +通过设置面板可切换: +- 深色/浅色主题 +- 自定义界面元素样式 + +## 代码结构 + +### Python模块 +- 文件管理:`get_desktop_path`, `open_file`, `copy_file`, `rename_file`, `remove_file`, `new_file` +- 窗口动画:`animate_window`, `ease_out_quad` +- 图标处理:`get_icon`, `match_ico` +- 配置管理:`update_inf`, `on_loaded` + +### HTML结构 +- 主容器:`.container` +- 文件列表:`#filesContainer`, `#filesListContainer` +- 右键菜单:`#contextMenu`, `#blankMenu` +- 操作面板:重命名/删除/新建/主题设置相关容器 + +### 样式文件 +- `all.min.css`:FontAwesome 图标样式 +- `dark.css`/`light.css`/`zzz.css`:不同主题样式表 +- 采用 BEM 命名规范 + +## 贡献指南 + +1. 克隆仓库:`git clone https://gitee.com/codevicent/easy-desktop` +2. 创建分支:`git checkout -b feature/your-feature` +3. 提交更改:`git commit -m 'Add some feature'` +4. 推送分支:`git push origin feature/your-feature` +5. 提交 Pull Request + +## 许可证 + +本项目采用 MIT 许可证。 \ No newline at end of file -- Gitee