📝 docs: metion cargo toolchain in CONTRIBUTING.md

yutto-dev · Nov 9, 2024 · 7d3351c · 7d3351c
1 parent 8343646
commit 7d3351c
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -24,6 +24,12 @@
 
 当然，如果你有更熟悉的编辑器或 IDE 的话，也是完全可以的。
 
+### Rust 开发工具链（可选）
+
+本 repo 是一个 monorepo，同时包含 yutto 和 biliass 两个包，其中 biliass 采用 Rust 编写，如果你有 biliass 联调的需求，则需要安装 Rust 工具链，安装方法请参考 [Rust 官方文档](https://www.rust-lang.org/tools/install)
+
+如果你不需要联调 biliass，那么可以通过注释掉 [pyproject.toml](./pyproject.toml) 中的 `tool.uv.sources` 和 `tool.uv.workspace`，避免 uv 将其当作一个子项目来处理。此时 uv 会安装 pypi 上预编译的 biliass wheel 包，而不会编译源码。这在大多数情况下是没有问题的，除非 yutto 使用了 biliass 的最新特性。
+
 ## 本地调试
 
 如果你想要本地调试，最佳实践是从 GitHub 上下载最新的源码来运行

diff --git a/README.md b/README.md
@@ -910,7 +910,7 @@ yutto 自诞生以来已经过去三年多了，功能上基本可以替代 bili
 -  [x] feat: 配置文件支持
 -  [x] feat: 配置文件功能优化，支持自定义配置路径
 -  [ ] docs: issue template 添加配置引导
--  [ ] docs: 优化 biliass rust 重构后的贡献指南
+-  [x] docs: 优化 biliass rust 重构后的贡献指南
 -  [ ] feat: 新的基于 toml 的任务列表
 -  [ ] refactor: 配置参数复用 pydantic 验证
 -  [ ] docs: 可爱的静态文档（WIP in [#86](https://github.com/yutto-dev/yutto/pull/86)）