Skip to content

docs: 中英文 README 改为写给开发者 - #88

Merged
rakuyoMo merged 1 commit into
mainfrom
feature/rakuyo/developer-readme
Nov 18, 2026
Merged

rakuyoMo merged 1 commit into
mainfrom
feature/rakuyo/developer-readme

Conversation

@rakuyoMo

Copy link
Copy Markdown
Owner

README 原先写给用户,以功能列表、权限与数据说明为主;现在改为写给开发者,讲清开发环境、构建与运行、架构、测试、调试与参与贡献的方式。功能介绍与使用方法留给项目网站。

改动

  • 中英文 README 按开发流程重新组织:简介、环境要求(开发环境,Git 与服务器)、构建与运行、架构概览、测试、调试(日志、Developer 菜单、数据存放的位置)、本地化、代码规范、发布、参与贡献与许可证
  • 顶部加上 CI、macOS 26+、Swift 6.2 与 GPL-3.0 的徽标
  • 写明 swift run 启动的可执行文件没有 App 包里的应用图标、更新说明、许可证与本地化的权限说明,更新与系统通知也不启用;需要时用 ./scripts/build-app.sh 生成开发版 App
  • 日志命令写成 /usr/bin/log:zsh 的 log 是内建命令,直接执行 log stream 会失败
  • 去掉面向用户的功能列表与权限说明,以及凭据、断线、联网这类从用户角度写的工作原理
  • AGENTS.md 中 README 的定位、修改时机与 “不写使用方法” 一条随之改为面向开发者,去掉 “已有的功能见 README”

验证

  • 两份 README 里的相对链接都指向仓库中存在的文件
  • README 引用的类型、Developer 菜单项、本地化测试的登记项与 swift run 的限制,都与 main 上的代码一致
  • /usr/bin/log stream 与 /usr/bin/log show 两条命令可以执行;zsh 下直接执行 log stream 报 too many arguments

未验证

  • 示例命令 swift test --filter LocalizationTests 没有在本机运行
  • 开发环境写的 “Swift 6.2 或更高版本” 取自 Package.swift 的 swift-tools-version,没有用对应版本的 Xcode 构建

注意

  • README 不再列出功能、权限与隐私相关的说明;项目网站上线前,这部分内容只在本 PR 之前的 README 里

@rakuyoMo
rakuyoMo merged commit 8b8f8e2 into main Nov 18, 2026
4 checks passed
@rakuyoMo
rakuyoMo deleted the feature/rakuyo/developer-readme branch November 19, 2026 09:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant