docs: web 端根说明补充 Markdown 版本 README.md

仓库首页(Gitea/编辑器)以 .md 为准,windows/android 两端都已有
README.md + README.txt 两份,web 端此前只有 README.txt。
本次按同风格补齐 README.md:标题/状态/初次部署/环境变量/API/目录结构
等改为 Markdown 结构(标题层级、表格、带语言的代码块),内容与
README.txt 逐项等价;同时把 README.md 纳入发布包与关键文件校验。
This commit is contained in:
opendance
2026-09-15 21:53:29 +08:00
parent 60c182f1b2
commit b7748a50eb
2 changed files with 528 additions and 3 deletions
+5 -3
View File
@@ -9,7 +9,8 @@
# systemd|openrc|initd / proxy(反代说明文档,仅文档不部署)
# contracts/ 当前版本契约快照
# THIRD_PARTY.md 开源项目声明
# README.txt 使用说明
# README.md 使用说明(Markdown, 仓库首页展示的就是它)
# README.txt 使用说明(纯文本同内容版本)
#
# 用法:./scripts/package-release.sh [版本号]
# ============================================================
@@ -76,7 +77,7 @@ cp -r deploy "$STAGE/deploy"
rm -f "$STAGE/deploy/.env"
rm -rf "$STAGE/deploy"/systemd/*.bak "$STAGE/deploy"/openrc/*.bak "$STAGE/deploy"/initd/*.bak
cp -r contracts "$STAGE/contracts"
cp THIRD_PARTY.md README.txt project.yaml DSH.md "$STAGE/"
cp THIRD_PARTY.md README.txt README.md project.yaml DSH.md "$STAGE/"
cp -r tasks "$STAGE/tasks"
# ---------- 5. 打包 ----------
@@ -135,7 +136,8 @@ for required in \
"opendance-web-v${VERSION}/deploy/systemd/opendance-api.service" \
"opendance-web-v${VERSION}/contracts/VERSION" \
"opendance-web-v${VERSION}/THIRD_PARTY.md" \
"opendance-web-v${VERSION}/README.txt" ; do
"opendance-web-v${VERSION}/README.txt" \
"opendance-web-v${VERSION}/README.md" ; do
if ! grep -qx "$required" <<< "$MANIFEST_TMP"; then
echo " ✗ 缺少关键文件:$required" >&2
fail=1