From 4526284902d1cce45181818eedc2cd7ba94b3697 Mon Sep 17 00:00:00 2001
From: SharwOrange <kuliangcha@qq.com>
Date: Wed, 27 Dec 2023 22:08:06 +0800
Subject: [PATCH] =?UTF-8?q?=E9=87=8D=E6=96=B0=E6=B7=BB=E5=8A=A0=E4=BA=86RE?=
 =?UTF-8?q?ADME?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 readme.md | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..439213e
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,42 @@
+# icalingua bot
+
+这是一个基于 icalingua docker 版的 bot
+
+> 出于某个企鹅, 和保护 作者 和 原项目 ( ica ) 的原因 \
+> 功能请自行理解
+
+## 使用方法
+
+- 安装依赖
+
+```powershell
+python -m pip install -r requirement.txt
+```
+
+> 如果你想使用虚拟环境 \
+> 可以使用 `python -m venv venv` 创建虚拟环境 \
+> 然后使用 `venv\Scripts\activate` 激活虚拟环境 \
+> 最后使用 `python -m pip install -r requirement.txt` 安装依赖
+
+- 修改配置文件
+
+```powershell
+Copy-Item config-temp.toml config.toml
+# 欸我就用 powershell 
+```
+
+- icalingua 启动!
+
+```bash
+# 用你自己的方法启动你的 icalingua 后端
+# 例如
+docker start icalingua
+# 或者
+docker up -d
+```
+
+- bot 启动!
+
+```powershell
+python connect.py
+```
\ No newline at end of file