refactor: split workspace and delivery layout

README.md

@@ -1,157 +1,37 @@
-# 手机品牌型号汇总
+# MobileModels Workspace
 
-[![issues](https://img.shields.io/github/issues/KHwang9883/MobileModels?color=green)](https://github.com/KHwang9883/MobileModels/issues)
-[![prs](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/KHwang9883/MobileModels/pulls)
-[![stars](https://img.shields.io/github/stars/KHwang9883/MobileModels.svg?color=yellow)](https://github.com/KHwang9883/MobileModels)
-[![forks](https://img.shields.io/github/forks/KHwang9883/MobileModels.svg?color=orange)](https://github.com/KHwang9883/MobileModels)
-[![License: CC BY-NC-SA 4.0](https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/)
+当前仓库按两层结构组织：
 
-汇总各厂商上市的手机型号与对应的传播名。
+- `workspace/`
+  - 工作空间
+  - 存放上游原始数据、补充资料和历史变更文件
+- `delivery/`
+  - 交付物
+  - 存放可直接运行的 Docker Compose 项目、Web 页面、MySQL schema 和交付文档
 
-[English](README_en.md)
+## 使用方式
 
-## Web UI
-
-项目内置了设备查询与数据管理页面，统一通过 `docker compose` 启动：
+进入交付目录启动：
 
 ```bash
+cd delivery
 docker compose up --build -d
 ```
 
-打开：
+页面入口：
 
 - `http://127.0.0.1:8123/web/device_query.html`
 - `http://127.0.0.1:8123/web/brand_management.html`
+- `http://127.0.0.1:8123/web/device_query.html?view=docs`
 
-MySQL 也会一并启动：
+## 目录说明
 
-- host: `127.0.0.1`
-- port: `3306`
-- database: `mobilemodels`
-- reader user: `mobilemodels_reader`
+```text
+workspace/  原始数据与工作空间
+delivery/   可交付运行物
+```
 
-如需自定义 MySQL 账号密码，可先复制 `.env.example` 为 `.env` 后再启动。
-原始数据、索引和 MySQL seed 运行时持久化在 Docker volume 中，不再回写本地工作区。
+更多交付说明见：
 
-更多说明参见 [web/README.md](web/README.md)。
-
-- ✅ 包含
-- ⏹ 仅部分包含
-- ❌ 不包含
-
-| 名称 | 品牌 | 汇总范围 | codename | 海外机型 | 备注 |
-| :-: | :-: | :-: | :-: | :-: | :-: |
-| [360shouji](brands/360shouji.md) | 360 手机 | 全部 360/奇酷手机 | ❌ | ❌ | -- |
-| [apple_all](brands/apple_all.md) | Apple | 全部 iPhone/iPad/iPod touch/Apple Watch/Apple TV/Apple Vision | ✅ | ✅ | -- |
-| [apple_all_en](brands/apple_all_en.md) | Apple | 全部 iPhone/iPad/iPod touch/Apple Watch/Apple TV/Apple Vision | ✅ | ✅ | 英文版 |
-| [apple_cn](brands/apple_cn.md) | Apple | 全部国行 iPhone/iPad/iPod touch/Apple Watch/Apple Vision | ✅ | ❌ | -- |
-| [asus_cn](brands/asus_cn.md) | 华硕 (ASUS) | ROG Phone 等 | ✅ | ❌ | -- |
-| [asus_en](brands/asus_en.md) | 华硕 (ASUS) | ROG Phone/Zenfone | ✅ | ✅ | 英文版 |
-| [blackshark](brands/blackshark.md) | 黑鲨 (Black Shark) | 全部机型 | ✅ | ✅ | -- |
-| [blackshark_en](brands/blackshark_en.md) | 黑鲨 (Black Shark) | 全部机型 | ✅ | ✅ | 英文版 |
-| [coolpad](brands/coolpad.md) | 酷派 (Coolpad) | 酷派近年智能手机机型 | ❌ | ❌ | -- |
-| [google](brands/google.md) | Google | Google Pixel 手机/平板/手表 | ✅ | ✅ | 英文版 |
-| [honor_cn](brands/honor_cn.md) | 荣耀 (HONOR) | 荣耀手机/平板/笔记本电脑/智慧屏/穿戴设备，仅包含国行型号 | ⏹ | ❌ | -- |
-| [honor_global_en](brands/honor_global_en.md)| 荣耀 (HONOR) | 荣耀手机/平板，仅包含海外型号 | ⏹ | ✅ | 英文版 |
-| [huawei_cn](brands/huawei_cn.md) | 华为 (HUAWEI) | 华为 Mate/Pura/nova/G/麦芒/畅享系列、平板电脑、MateBook、智慧屏及穿戴设备，仅包含国行型号 | ⏹ | ❌ | [其他早期型号参阅此处](misc/early-huawei-models.md) |
-| [huawei_global_en](brands/huawei_global_en.md)| 华为 (HUAWEI) | 华为 Mate/Pura/nova/Y 系列及平板电脑，仅包含海外型号 | ⏹ | ⏹ | 英文版 |
-| [lenovo_cn](brands/lenovo_cn.md) | 联想 (Lenovo) | 联想品牌 2017 年起上市的机型、ZUK 全部机型 | ✅ | ❌ | -- |
-| [letv](brands/letv.md) | 乐视 (Letv) | 全部手机机型 | ❌ | ❌ | 不包含电视产品 |
-| [meizu](brands/meizu.md) | 魅族 (MEIZU) | 全部机型 | ✅ | ✅ | -- |
-| [meizu_en](brands/meizu_en.md) | 魅族 (MEIZU) | 全部机型 | ✅ | ✅ | 英文版 |
-| [mitv_cn](brands/mitv_cn.md) | 小米 (Xiaomi) | 全部国行小米/Redmi 电视、机顶盒 | ❌ | ❌ | -- |
-| [mitv_global_en](brands/mitv_global_en.md) | 小米 (Xiaomi) | 全部小米/Redmi 电视、机顶盒、智能电视棒，仅包含海外型号 | ❌ | ✅ | 英文版 |
-| [motorola_cn](brands/motorola_cn.md) | 摩托罗拉 (Motorola) | 2015 年起上市的机型 | ✅ | ❌ | -- |
-| [nokia_cn](brands/nokia_cn.md) | 诺基亚 (Nokia) | 2017 年起由 HMD Global 制造的智能手机机型 | ✅ | ❌ | -- |
-| [nothing](brands/nothing.md) | Nothing | 全部机型 | ✅ | ✅ | 英文版 |
-| [nubia](brands/nubia.md) | 努比亚 (nubia) | 全部机型 | ❌ | ⏹ | -- |
-| [oneplus](brands/oneplus.md) | 一加 (OnePlus) | 全部机型 | ✅ | ✅ | -- |
-| [oneplus_en](brands/oneplus_en.md) | 一加 (OnePlus) | 全部机型 | ✅ | ✅ | 英文版 |
-| [oppo_cn](brands/oppo_cn.md) | OPPO | 2018 年起新型号命名方式的国行机型 | ⏹ | ❌ | -- |
-| [oppo_global_en](brands/oppo_global_en.md) | OPPO | 2018 年起上市的海外机型 | ⏹ | ⏹ | 英文版 |
-| [realme_cn](brands/realme_cn.md) | 真我 (realme) | 全部国行机型 | ⏹ | ❌ | -- |
-| [realme_global_en](brands/realme_global_en.md) | 真我 (realme) | 全部海外机型 | ⏹ | ✅ | 英文版 |
-| [samsung_cn](brands/samsung_cn.md) | 三星 (Samsung) | Galaxy S/Note/A/Z/M/C/J/On/Tab/心系天下系列及个别其他机型，仅包含国行型号 | ✅ | ❌ | [其他早期型号参阅此处](misc/early-samsung-models.md) |
-| [samsung_global_en](brands/samsung_global_en.md) | 三星 (Samsung) | Galaxy S/Note/A/Z/M/F 系列，2019 年起上市的机型 | ✅ | ⏹ | 英文版 |
-| [smartisan](brands/smartisan.md) | 坚果 (Smartisan) | 全部机型 | ✅ | ❌ | -- |
-| [sony](brands/sony.md) | 索尼 (SONY) | 2015 年起上市的机型 | ✅ | ✅ | 英文版 |
-| [sony_cn](brands/sony_cn.md) | 索尼 (SONY) | 2015 年起上市的国行机型 | ✅ | ❌ | -- |
-| [vivo_cn](brands/vivo_cn.md) | vivo | 2018 年起新型号命名方式的国行机型 | ✅ | ❌ | -- |
-| [vivo_global_en](brands/vivo_global_en.md) | vivo | 2019 年起上市的海外机型 | ⏹  | ⏹ | 英文版 |
-| [xiaomi](brands/xiaomi.md) | 小米 (Xiaomi) | 小米/REDMI/POCO 手机 & 平板等 | ✅ | ✅ | -- |
-| [xiaomi_cn](brands/xiaomi_cn.md) | 小米 (Xiaomi) | 小米/REDMI 手机 & 平板等 | ✅ | ✅ | 英文版 |
-| [xiaomi_en](brands/xiaomi_en.md) | 小米 (Xiaomi) | 小米/REDMI/POCO 手机 & 平板等 | ✅ | ✅ | 英文版 |
-| [xiaomi-wear](brands/xiaomi-wear.md) | 小米 (Xiaomi) | 小米/Redmi 手表、手环、TWS 等穿戴设备 | ⏹ | ✅ | TWS 不包含外包型号；暂不含儿童手表型号 |
-| [zhixuan](brands/zhixuan.md) | 华为智选 | U-MAGIC 优畅享/电信麦芒/NZONE/Hi nova/雷鸟 FFALCON/TD Tech/WIKO | ⏹ | ❌ | -- |
-| [zte_cn](brands/zte_cn.md) | 中兴 (ZTE) | 2017 年起上市的机型 | ❌ | ❌ | -- |
-
-## 更新日志
-
-参见 [CHANGELOG.md](CHANGELOG.md)
-
-## 许可
-
-<a rel="license" href="https://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="知识共享许可协议" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br />本作品采用 <a rel="license" href="https://creativecommons.org/licenses/by-nc-sa/4.0/">知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议</a> 进行许可。
-
-## 项目历史
-
-### 2024 年 3 月
-- 将本项目 csv 及脚本迁移至 [此 repo](https://github.com/KHwang9883/MobileModels-csv)，使用 GitHub Actions 自动更新。
-
-### 2022 年 4 月
-- 新增 [各大 Android 厂商 BL 解锁/内核开源情况](https://github.com/KHwang9883/bootloader-kernel-source) 汇总（已停更）。
-
-### 2021 年 12 月
-- 新增 [各品牌型号命名规则](misc/naming-rules.md) 汇总。
-
-### 2019 年 7 月
-- 文档版停止维护。
-
-### 2019 年 4 月
-- 文档版迁移至 GitHub 直链下载。
-- 新增英文版。
-
-### 2019 年 3 月
-- 文档版迁移至微云。
-
-### 2018 年 11 月
-- 项目同步至 GitHub。
-
-### 2018 年 7 月
-- 由于小米社区帖子失效，「手机品牌型号汇总」项目公开发布，提供文档版百度网盘下载。
-
-### 2016 年 3 月
-- 小米手机型号汇总发布至 [小米社区](http://bbs.xiaomi.cn/t-12641411)（帖子已失效）。
-
-### 2016 年 2 月
-- 我开始汇总一些国内手机品牌的型号，「手机品牌型号汇总」的雏形诞生。
-
-[![Stargazers over time](https://starchart.cc/KHwang9883/MobileModels.svg)](https://starchart.cc/KHwang9883/MobileModels)
-
-## 参考资料
-
-- [电信设备终端网](http://zd.taf.org.cn)
-- [产品认证证书查询](http://webdata.cqccms.com.cn/webdata/query/CCCCerti.do)
-- [工业和信息化部政务服务平台](https://ythzxfw.miit.gov.cn/resultQuery)
-- [产品库-中国电信天翼终端信息平台](http://surfing.tydevice.com/)
-- [Google Play 支持的设备](http://storage.googleapis.com/play_public/supported_devices.html)
-- [Wi-Fi Alliance](https://www.wi-fi.org)
-- [Bluetooth Launch Studio](https://launchstudio.bluetooth.com/Listings/Search)
-- [Xiaomi Firmware Updater](https://xiaomifirmwareupdater.com/)
-- [Huawei Open Source Release Center](https://consumer.huawei.com/en/opensource/)
-- [ReaMEIZU](https://reameizu.com/)
-- [The Apple Wiki](https://theapplewiki.com/)
-- [ipsw.me](https://ipsw.me)
-- [XDA Developers](https://www.xda-developers.com)
-- [Huawei Firmware Database](https://pro-teammt.ru/en/online-firmware-database-ru/)
-- [XSMS IMEI 数据库](http://xsms.com.ua/phone/imei/all/1)
-- [Android Dumps](https://dumps.tadiphone.dev/dumps)
-- [Lenovo Android タブレット一覧](https://idomizu.dev/archives/20150)
-
-以及各品牌官网、论坛、微博等，恕不一一列出
-
-## 联系方式
-
-如有相关问题，请 [提交 Issue](https://github.com/KHwang9883/MobileModels/issues)。如有错误或缺漏，欢迎提交 PR。
-
-其他平台同名（@KHwang9883），但不一定回复本 repo 相关问题。
+- [delivery/README.md](delivery/README.md)
+- [delivery/docs/README.md](delivery/docs/README.md)