初始化交付包标准目录树:元数据README、节点说明与合同对齐规范
This commit is contained in:
@@ -0,0 +1,14 @@
|
||||
# 项目名称
|
||||
|
||||
> 本文件为交付包根目录唯一 README 的占位模板。交付时用项目标准化 README 替换,
|
||||
> 必须包含合同约定的 12 项内容,并保证引用图片可在 `docs/` 下正常显示。
|
||||
|
||||
一句话项目简介……
|
||||
|
||||
## 功能(逐条对应截图)
|
||||
## 行业痛点 / 技术优势 / 应用场景 / 目标人群 / 商业价值
|
||||
## 技术架构(含框架拓扑图)
|
||||
## 环境依赖
|
||||
## 快速开始
|
||||
## 安装部署教程(优先 Docker 一键部署)
|
||||
## 开源协议合规说明
|
||||
@@ -0,0 +1,2 @@
|
||||
# 交付时替换为项目真实 Dockerfile
|
||||
# FROM <base>
|
||||
@@ -0,0 +1,3 @@
|
||||
# Docker 一键部署
|
||||
|
||||
适配 Docker 的项目必须提供一键部署脚本/部署包;不适配的需提供书面说明。
|
||||
@@ -0,0 +1,6 @@
|
||||
# 交付时替换为项目真实 docker-compose.yml
|
||||
# services:
|
||||
# app:
|
||||
# image: <image>
|
||||
# ports:
|
||||
# - "8080:80"
|
||||
@@ -0,0 +1,4 @@
|
||||
# README 引用配图
|
||||
|
||||
本目录存放根 README 通过相对路径引用的全部图片(架构拓扑图、功能配图等)。
|
||||
`build_delivery_package.py` 会自动解析 README 中的图片引用并从项目中收拢到此处,解压即可显示。
|
||||
@@ -0,0 +1,5 @@
|
||||
# 录屏
|
||||
|
||||
全功能操作演示录屏(建议命名 `full-feature-demo.mp4`)。
|
||||
要求:无卡顿、无黑屏、声画清晰,完整演示所有功能模块。
|
||||
mp4 为二进制不入库(见 .gitignore),交付时由构建脚本放入。
|
||||
@@ -0,0 +1,3 @@
|
||||
# AI对话
|
||||
|
||||
AI 对话与接口配置 的高清截图存放处。
|
||||
@@ -0,0 +1,3 @@
|
||||
# 界面截图
|
||||
|
||||
改造后的产品界面高清截图(中性命名,不体现版本对比或来源宣传),按模块分组,全覆盖无遗漏。
|
||||
@@ -0,0 +1,3 @@
|
||||
# 园区态势
|
||||
|
||||
园区实时态势、摄像头分布 的高清截图存放处。
|
||||
@@ -0,0 +1,3 @@
|
||||
# 报警中心
|
||||
|
||||
报警事件列表与详情 的高清截图存放处。
|
||||
@@ -0,0 +1,3 @@
|
||||
# 登录页
|
||||
|
||||
登录界面 的高清截图存放处。
|
||||
@@ -0,0 +1,3 @@
|
||||
# 监控大屏
|
||||
|
||||
多路监控墙、数据大屏 的高清截图存放处。
|
||||
@@ -0,0 +1,3 @@
|
||||
# 系统管理
|
||||
|
||||
地图/摄像头/规则/用户管理 的高清截图存放处。
|
||||
@@ -0,0 +1,3 @@
|
||||
# 首页
|
||||
|
||||
首页 / 仪表盘 / overview 的高清截图存放处。
|
||||
@@ -0,0 +1,4 @@
|
||||
# 文档
|
||||
|
||||
除根 README 外的交付说明文档:环境依赖清单与部署注意事项。
|
||||
本目录不再放 README。
|
||||
@@ -0,0 +1,7 @@
|
||||
# 环境依赖清单
|
||||
|
||||
- 运行时:(如 Node 20 / MySQL 8 / JDK 17 / Python 3.11)
|
||||
- 中间件:(Redis / RTMP 服务等)
|
||||
- 硬件与资源:CPU / 内存 / 磁盘 / GPU(如需要)
|
||||
- 第三方服务:(如 AI API、对象存储、地图服务)
|
||||
- 版本与端口:
|
||||
@@ -0,0 +1,7 @@
|
||||
# 部署注意事项
|
||||
|
||||
- 必改的环境变量与密钥:
|
||||
- 数据初始化与默认账号(账号来源需注明):
|
||||
- 端口冲突与防火墙:
|
||||
- 数据卷挂载与备份:
|
||||
- 常见报错与排查:
|
||||
@@ -0,0 +1,7 @@
|
||||
# 网盘素材归档清单
|
||||
|
||||
- 网盘地址:<百度网盘链接>
|
||||
- 提取码:
|
||||
- 目录结构:截图/、录屏/
|
||||
- 链接有效期:长期 / 永久
|
||||
- 归档时间:
|
||||
Reference in New Issue
Block a user