summaryrefslogtreecommitdiff
path: root/docs/start.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/start.md')
-rw-r--r--docs/start.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/start.md b/docs/start.md
new file mode 100644
index 0000000..3a28eae
--- /dev/null
+++ b/docs/start.md
@@ -0,0 +1,38 @@
+# 前言
+!> 在阅读本文档时如碰到让您费解的专业词汇,请善用 百度/Bing/Google。
+
+!> 在运行期间出现任何错误,欢迎提交issues。如需提问,请先了[解提问的智慧](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/master/README-zh_CN.md),否则,您的提问大概率非常通常不会回复。
+
+### 关于
+本项目名称、灵感均来自 [ANIPLEX](https://aniplex-exe.com/) 发行的 [ATRI-My Dear Moments-](https://atri-mdm.com/)
+
+本项目中所使用的任何有关 ATRI 的图标、LOGO,解释权、著作权均归 ANIPLEX,由于本项目为开源项目且不收取任何费用,根据其条款,可以将其司作品进行使用。
+
+为QQ群中复现一个活灵活现的 ATRI 是本项目的目标。
+
+Owner 接触 Python 未满一年,故此项目所展示的内容可能会让您血压升高,请谅解,咱会在以后进行不间断改进。
+
+### 实现
+ATRI 可以在任何平台下运行,无论是 Windows 还是 linux 或者 iot,只要你具备基本 Python 环境和一根接入了互联网的网线,均可以运行本项目。
+
+此项目的实现方式是 `go-CQHTTP` + `NoneBot2`,以 `Python` 为主语言的项目。
+
+目前正在不断更新递代,经综合考虑后随缘打包,平时请直接拉取默认分支,如想体验最新功能,请切换项目分支至 `test`。注意,测试分支存在不确定性因素,包括:造成您电脑卡顿,同您电脑中其他正在运行的软件抢内存,造成您电脑硬盘空间爆满。如出现以上现象,请自行解决。
+
+**前身框架 CoolQ,谨此纪念 CoolQ 的停运和 “802” 事件**
+
+**“愿我们能在更开放的平行世界里相遇”**
+
+### 附加的一些介绍
+虽然现已处于正式版,功能均能正常运行,但源码就一屎山,就目前水平“能 跑 就 行”,还请各大佬高抬贵手(
+
+如对其运作效果感兴趣,请加入示例群聊:567297659
+
+### 其他
+本项目已启用爱发电,您的支持就是对项目拥有者的最大鼓励!
+
+并会将您的ID写在项目 README 特别感谢一栏!
+-> https://afdian.net/@Kyomotoi
+
+### 关于开源
+本项目使用 [GPLv3](https://github.com/Kyomotoi/Aya/blob/master/LICENSE) 开源协议,这意味着您可以运行本项目,并向您的用户提供服务,但如果您需要对项目的源码仅限修改,则必须将您修改后的版本对您的用户开源。