53 lines
2.9 KiB
Markdown
53 lines
2.9 KiB
Markdown
# 奇妙小屏幕控制器（核桃派 ZeroW）
|
||
|
||
这是一个可单独克隆、开发、测试和离线部署的核桃派 ZeroW/H618 项目，用于驱动单块 64×64 HUB75 RGB 点阵屏，并提供局域网页面、模板、动图、网络、OTA 和电压监控功能。
|
||
|
||
## 仓库结构
|
||
|
||
- `核桃派软件源代码/`：FastAPI 服务、网页、H618 HUB75 原生驱动、部署与发布脚本。
|
||
- `整体开发需求/`：带稳定编号的功能和部署需求。
|
||
- `测试相关资料/如何测试/`：本机、板端、实屏与 ADC 的分层测试流程。
|
||
- `硬件相关资料和硬件的连接/`：核桃派、HUB75 和 ADS1110 接线资料。
|
||
- `发布更新相关/`：官方基线 IMG、正式导出包、OTA、离线依赖和镜像编辑器。
|
||
- `各种归档/`：一次性验收证据和历史实现材料。
|
||
|
||
本私有仓库保留发布产物和离线依赖，并使用 Git LFS 管理已登记的大体积二进制。当前完整工作区超过 10 GiB；首次克隆和拉取需要安装 Git LFS，并为普通 Git 数据与 LFS 对象预留足够的磁盘空间和时间。
|
||
|
||
## 首次使用
|
||
|
||
1. 完整阅读 `AGENTS.md`、`整体开发需求/` 和与任务相关的测试、硬件资料。
|
||
2. 需要 SSH、实机部署或镜像定制时，运行：
|
||
|
||
```powershell
|
||
python ".\测试相关资料\核桃派的用户名和密码和ip\prepare_credentials.py"
|
||
```
|
||
|
||
3. 如果脚本创建了 `用户名密码ip.txt`，只编辑该文件并填完全部字段，然后重新运行检查。该私有文件被 Git 精确忽略；不要把内容复制到聊天、日志、源码或普通文档。
|
||
4. 运行仓库卫生检查：
|
||
|
||
```powershell
|
||
python ".\核桃派软件源代码\scripts\check_repository_hygiene.py"
|
||
```
|
||
|
||
5. 本机完整测试：
|
||
|
||
```powershell
|
||
python ".\测试相关资料\如何测试\本机测试环境\local_test.py" test --suite all
|
||
```
|
||
|
||
## Git 安全边界
|
||
|
||
根 `.gitignore` 是统一入口。真实设备凭据、私钥、本机环境、运行数据和可再生缓存不得提交；示例文件、源码、需求、测试、正式 IMG、OTA、离线依赖、编辑器程序及历史归档需要保留。提交前运行卫生检查，确认没有开发电脑绝对路径、私钥或高可信明文秘密。
|
||
|
||
仓库内描述源码位置时使用仓库相对路径或 `<仓库根目录>` 等文字占位符。核桃派生产路径 `/opt/matrix-screen-controller`、`/var/lib/matrix-screen-controller` 和 `/run/matrix-screen-controller` 是部署契约，不属于开发机路径。
|
||
|
||
可选的版本库 hook 位于 `.githooks/pre-commit`。当前 checkout 可执行以下命令启用：
|
||
|
||
```powershell
|
||
git config core.hooksPath .githooks
|
||
```
|
||
|
||
## 许可证
|
||
|
||
项目自有源码以 GNU General Public License v3.0 发布，见 `LICENSE`。仓库中随附的系统镜像、Debian 包、Python wheel、字体、FRP、硬件资料和其他第三方内容仍由各自许可证、版权声明或来源条款约束；GPLv3 不会替这些第三方材料重新授权。
|