From 5ae4635a9190d71554e90628d4aa3b64dfcc050a Mon Sep 17 00:00:00 2001 From: Reasonix AI Date: Wed, 19 Aug 2026 07:40:40 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E5=88=9D=E5=A7=8B=E5=8C=96=E5=85=B3?= =?UTF-8?q?=E6=B3=A8=E7=9A=84=E4=BB=A3=E7=A0=81=E5=BA=93=E5=90=88=E9=9B=86?= =?UTF-8?q?=E9=AA=A8=E6=9E=B6?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..73884ec --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +# 关注的代码库合集(Codebase Collection) + +> 用途:聚合我们关注 / 追踪的代码库,通过 **Git 子模块(submodule)** 统一管理。 +> 更新日期:2026-08-16 + +## 收录清单 + +> 待补充。格式约定: + +| 名称 | 子模块路径 | 仓库地址 | 用途 | 关注原因 | 备注 | +|------|-----------|---------|------|---------|------| +| (示例)LiveKit | livekit/livekit | https://github.com/livekit/livekit | SFU 视频会议服务 | 自建媒体服务器核心 | 外部仓库,考虑镜像 | + +## 使用说明 + +- **首次克隆**(含全部子模块): + + ```bash + git clone --recursive <合集仓库地址> + ``` + +- **拉取全部子模块最新代码**(跟随上游): + + ```bash + git submodule update --remote + ``` + +- **新增一个代码库**: + + ```bash + git submodule add <仓库地址> <子模块路径> + git commit -m "chore: 收录 <名称>" + ``` + +- **更新子模块引用并提交**: + + ```bash + git add . + git commit -m "chore: 同步子模块引用" + ``` + +## 收录规范(建议) + +- **内部仓库**(git.vanusys.com 上):直接以子模块收录。 +- **外部开源仓库**(GitHub 等): + - 优先在 git.vanusys.com 建立镜像后再收录,避免子模块依赖外部网络(国内服务器拉取 GitHub 可能超时); + - 或仅在本表登记地址与用途,不强制挂子模块。 +- 子模块只记录**提交引用**,不会自动跟随上游改动,需定期 `git submodule update --remote` 同步。