소스 검색

docs: README.md 更新,文档骨架

dzp 4 년 전
부모
커밋
270d2f4b96
1개의 변경된 파일25개의 추가작업 그리고 2개의 파일을 삭제
  1. 25 2
      README.md

+ 25 - 2
README.md

@@ -1,2 +1,25 @@
-# tt-pkuxkx
-专为北大侠客行定制的 tintin++ 客户端,包括一些必要的 patch 和基本的触发
+# PaoTin++
+
+这是一个基于 [TinTin++](https://github.com/scandum/tintin) 的定制发行版。包括一些尚未被合并进官方 TinTin++ 版本的 patch 和一些基础性的框架代码,企图能够对 TinTin++ 的功能有所增强。
+
+# 运行方式
+
+## 本地运行
+
+```
+TODO
+```
+
+## Docker 方式运行
+
+### 预编译的 Docker
+
+```
+TODO
+```
+
+### 自行编译 Docker
+
+```
+TODO
+```