Skip to content

docs(readme): 补强中文首屏并验证可复现性 - #12

Merged
wubing7755 merged 1 commit into
mainfrom
docs/readme-discovery
Nov 2, 2026
Merged

wubing7755 merged 1 commit into
mainfrom
docs/readme-discovery

Conversation

@wubing7755

Copy link
Copy Markdown
Member

摘要

  • 改了什么:在既有中文首屏上做最小增补 —— 增加一行英文定位语、状态行(v0.1.0 / 2026-10-23 / MIT / 三平台 CI)、CI + Static Analysis + Release 三枚动态徽章(保留原有 C11/CMake/License 静态徽章)、Release/文档/贡献/变更日志链接行,以及真实终端记录(--version、--help、REPL 求值)。
  • 快速开始校准:补齐 Python 3 前置(cmake/Tests.cmake 的 CTest 门禁硬依赖);「使用方式」注明真实输出带有 [YYYY-MM-DD HH:MM:SS] [INFO] 前缀。
  • 为什么:让陌生开发者在 10 秒内知道项目是什么、给谁用、当前版本状态,并能按 README 在 3 分钟内完成构建与首次计算;同时避免静态徽章无法自证构建状态。
  • 不新建 README.en.md:按本仓库 C_PROJECT_STANDARD.md / CHANGELOG.md 的「只维护中文、勿引入双语镜像」约定,只在中文 README 顶部保留一行英文定位语。
  • 未使用 --debug 示例:其输出会回显编译期绝对路径(__FILE__),不适合放入 README。

验证

  • ctest --preset ninja-debug -L documentation --output-on-failure — 1/1 通过(calcexpr_docs_check)
  • ctest --preset ninja-debug --output-on-failure — 7/7 通过(architecture 3 / documentation 1 / packaging 1 / unit 2)
  • 真实终端记录:--version → calcexpr 0.1.0;--help;printf '2+3*4\n1e-3*5\n1/0\n' | ./build/ninja-debug/bin/calcexpr.exe → 14 / 0.005 / 除数为零(输出含真实时间戳)
  • 相对链接 0 断链;未新增 docs 文件/索引项;README 内 #文档 锚点经 calcexpr_docs_check 验证
  • 分支页面渲染:3 个表格、6 枚徽章、#项目简介/#文档 锚点存在
  • 徽章全部实测 200:CI、Static Analysis、Release v0.1.0、License(以及既有 C11/CMake)
  • 未跑:MSVC/macOS/Linux 实际构建、ninja-asan/ninja-coverage、clang-format/tidy(本机未安装);原因:本轮仅 README 改动,默认 debug 预设与文档门禁已通过
  • 未跑:./scripts/check.ps1(会触发本机 clang-format 版本差异;改动不涉及源码)

影响

  • 公共 API 影响:无
  • 构建、CI、打包或发布影响:无(未改 CMake / workflow / 版本号)
  • 文档影响:仅 README.md(中文);未新增英文镜像、未新增 docs 文件
  • 已知仓库外问题(本轮未修):CMakeLists.txt 的 HOMEPAGE_URL 仍指向 wubing7755/calc-expr(301 到 HestiaLab);docs/guides/cmake.md:290 有 c-project-standard 模板残留;docs/guides/debug-system.md 关于 Release --debug 的提示与实测不符

AI 辅助

  • 使用了 AI 辅助并已披露,包括已读文档和已运行的验证。
  • 说明:AI 完成 README 增补、文档门禁/CTest 运行与真实终端记录采集;人工复核与合并由维护者执行。

未合并,等待维护者。

@wubing7755
wubing7755 merged commit 09a0b33 into main Nov 2, 2026
17 checks passed
@wubing7755
wubing7755 deleted the docs/readme-discovery branch November 2, 2026 01:53
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