From c1315cf014cc3726783ff9e9a54ccdd00737156b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E8=94=A1=E5=8D=8E=E8=B0=A6?= <caihq@pku.edu.cn>
Date: Fri, 29 Oct 2021 07:41:02 +0000
Subject: [PATCH] add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f9675ba
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# 项目说明
+初次clone可使用以下命令。
+```bash
+git clone  https://xxxx/XXX-bundle.git
+```
+在git clone之后执行
+```bash
+git submodule update --init
+
+```
+
+```bash
+git submodule foreach -q --recursive 'git checkout $(git config -f $toplevel/.gitmodules submodule.$name.branch || echo master)'
+```
+
+更新所有子项目：
+```
+git pull --rebase --recurse-submodules
+```
+
+## 配置说明
+首次配置，需要配置Yjs路径。
+同时还需要配置启动路径。
\ No newline at end of file