# buttler

**Repository Path**: angtk/buttler

## Basic Information

- **Project Name**: buttler
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: LGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-07
- **Last Updated**: 2026-01-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Buttler - 个人日记管理工具

## 项目介绍

Buttler是一个基于Qt开发的个人日记管理工具，帮助用户快速记录每日计划、进展和复盘，支持Markdown格式输出。

## 功能特性

- ✅ 快速创建当日日记文件
- ✅ 自动生成Markdown格式日记模板
- ✅ 支持添加今日计划任务
- ✅ 支持记录项目工作进展
- ✅ 支持记录问题与解决方案
- ✅ 支持当日复盘总结
- ✅ 配置参数持久化存储
- ✅ 支持邮件发送功能
- ✅ 全局快捷键支持

## 技术栈

- C++
- Qt 5.14.2
- QMake构建系统
- SMTP邮件发送库
- Markdown格式

## 项目结构

```
buttler/
├── SMTPEmail/         # 邮件发送相关库
├── doc/               # 文档目录
├── images/            # 图片资源
├── qxtglobalshortcut/ # 全局快捷键库
├── release/           # 编译输出目录
├── .gitignore         # Git忽略文件
├── buttler.pro        # 项目配置文件
├── config.cpp         # 配置管理
├── config.h           # 配置头文件
├── dlg_setting.cpp    # 设置对话框
├── dlg_setting.h      # 设置对话框头文件
├── dlg_setting.ui     # 设置对话框UI
├── emailsender.cpp    # 邮件发送器
├── emailsender.h      # 邮件发送器头文件
├── main.cpp           # 主入口
├── mainwindow.cpp     # 主窗口
├── mainwindow.h       # 主窗口头文件
├── mainwindow.ui      # 主窗口UI
└── README.md          # 项目说明
```

## 安装与构建

### 前置条件

- Qt 5.14.2或更高版本
- MinGW 7.3.0或兼容编译器
- Git

### 构建步骤

1. 克隆项目
   ```bash
   git clone https://gitee.com/angtk/buttler.git
   cd buttler
   ```

2. 使用Qt Creator打开项目
   - 打开 `buttler.pro` 文件
   - 配置构建环境
   - 点击构建按钮

3. 命令行构建
   ```bash
   qmake
   mingw32-make
   ```

## 使用方法

1. **启动程序**
   - 运行 `release/buttler.exe`

2. **创建当日日记**
   - 程序会自动在配置的日记目录中创建当日日记文件

3. **添加任务**
   - 在主界面输入任务标题和详情
   - 点击添加按钮，任务会自动添加到"今日计划"部分

4. **配置设置**
   - 点击设置按钮进入配置界面
   - 可配置日记存储路径、邮件发送设置等

## 日记模板格式

```markdown
---
alias:
  - 2026年01月07日日记
tags:
  - 日记
  - 2026年
  - 01月07日
---
# 2026年01月07日日记

## 今日计划

- [x] ex1.添加今日第一项任务（10:00-11:30）

## 进展记录

### 项目工作

- [x] ex1.项目：详细描述（已完成）

### 问题与解决方案

- 问题：

- 解决：

## 当日复盘
```

## 配置说明

配置文件存储在本地，支持以下配置项：

- 日记存储路径
- 日期格式
- 时间格式
- 邮件发送设置
- 淡入淡出动画时长

## 全局快捷键

- 显示/隐藏主窗口：可在设置中配置

## 邮件功能

支持通过SMTP发送邮件，可用于备份日记或发送提醒。

## 贡献指南

欢迎提交Issue和Pull Request来改进项目。

## 许可证

本项目采用MIT许可证。

## 联系方式

- 作者：zhanghb
- 邮箱：zhaingbo@foxmail.com
- 项目地址：https://gitee.com/angtk/buttler

---

**版本**：v1.0.0
**最后更新**：2026年01月07日