From 9932e81157b6a5b323d0cf52a7067cd7cecf11ea Mon Sep 17 00:00:00 2001
From: iridiumR <i@iridium.cyou>
Date: Tue, 23 May 2023 17:57:12 +0800
Subject: [PATCH] =?UTF-8?q?chore:=20=E5=88=9B=E5=BB=BA=20README?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2c3fcb5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+### 技术栈
+
+- 语言: Python
+- 库：
+    - PyQt6: 程序界面
+    - psycopg2: 连接 Postgres 数据库
+    - json：处理 json 格式
+- 数据库: PostgreSQL
+
+
+### 部署方法
+
+```
+pip install -r requirements.text
+```
+
+### 启动方法
+
+```
+python src/main.py
+```
+
+### 开发方法
+
+用 VS Code 打开 `src` 文件夹，通过边栏里的“调试”窗口运行。逻辑都在 `budget` 模块里。
+
+### 模块说明
+
+程序界面分为主装口和多个菜单栏(`TabPage`)。
+
+每个菜单栏类中包括界面初始化和槽连接的逻辑。
+
+类的继顺序为 菜单栏 -> `TabPage` (在 `_tab.py` 里) -> `QWidget`
+
+预计应该有这样的几个页面：
+
+- [x] 数据库连接（已经写了）
+- [ ] 账户管理（没写完）
+- [ ] 账目分类管理（没写完）
+- [ ] 记录管理（没开始写）
+- [ ] 统计页面（没开始写）
+
+已经写了不少了照葫芦画瓢总能画吧