Skip to content

Commit 18955e1

Browse files
committed
更新说明
1 parent 9e5f6a3 commit 18955e1

3 files changed

Lines changed: 243 additions & 242 deletions

File tree

README.md

Lines changed: 91 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -1,153 +1,153 @@
1-
[English](README_EN.md) **中文**
1+
[中文说明, 请点击这里](README_CN.md)
22
---
33

4-
## ⚠️ 重要提醒
4+
## ⚠️ Important Notice
5+
6+
### 📦 Firmware Usage Guidelines
7+
- 🚫 **Do NOT use test versions of firmware in production environments. All test firmware filenames contain `dev`.**
8+
9+
- 🎯 **Purpose of This Project:**
10+
Designed to allow Chinese users to seamlessly enjoy the native Home Assistant OS experience without worrying about network accessibility issues.
511

6-
### 📦 固件使用说明
7-
- 🚫 **请勿错误的将测试版固件用于生产环境,测试版固件名称均包含`dev`**
812
---
913

10-
### 🛡️ 服务器保护措施
14+
### 🛡️ Server Protection Measures
1115

12-
由于近期服务器遭受大量无效流量(日均数万次无效请求),为保护服务器资源并降低运营成本,我们采取了以下措施:
16+
Due to a recent surge of excessive invalid server requests (up to tens of thousands daily), to protect server resources and reduce operational costs, we've implemented the following strategies:
1317

14-
- 🔒 **代码开源**:项目代码继续完全开源,遵循开源精神
15-
- 🛡️ **构建保护**:隐藏构建过程包含服务器的相关信息,防止恶意(或无心)引用
18+
- 🔒 **Open Source Commitment**: Project source code remains fully open, adhering strictly to the open source spirit.
19+
- 🛡️ **Build Information Protection**: Server-related information is concealed during the build process to prevent malicious or unintentional reference.
1620

1721
---
1822

19-
## ![Home Assistant OS 极速版](https://img.shields.io/badge/Home%20Assistant%20OS-%E6%9E%81%E9%80%9F%E7%89%88-41BDF5?style=for-the-badge&logo=home-assistant&logoColor=white) ![Home Assistant OS China](https://img.shields.io/badge/Home%20Assistant%20OS-China-41BDF5?style=for-the-badge&logo=home-assistant&logoColor=white) ![Home Assistant OS Turbo](https://img.shields.io/badge/Home%20Assistant%20OS-Turbo-41BDF5?style=for-the-badge&logo=home-assistant&logoColor=white)
23+
## ![Home Assistant OS Turbo Edition](https://img.shields.io/badge/Home%20Assistant%20OS-%E6%9E%81%E9%80%9F%E7%89%88-41BDF5?style=for-the-badge&logo=home-assistant&logoColor=white) ![Home Assistant OS China](https://img.shields.io/badge/Home%20Assistant%20OS-China-41BDF5?style=for-the-badge&logo=home-assistant&logoColor=white) ![Home Assistant OS Turbo](https://img.shields.io/badge/Home%20Assistant%20OS-Turbo-41BDF5?style=for-the-badge&logo=home-assistant&logoColor=white)
2024
### [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/ha-china/HAOS-CN) [`Changelog`](https://www.hasscn.top/Changelog.html)
2125

2226

27+
**This system is an optimized Home Assistant OS distribution, tailored specifically for users in China and based on the [official Home Assistant repository](https://github.com/home-assistant/operating-system).**
2328

24-
**本系统是基于Home Assistant [官方仓库](https://github.com/home-assistant/operating-system)优化而来**
25-
26-
### 🚀 网络加速优化
27-
- 🕵️‍♂️ `版本检测服务`迁移至国内腾讯BGP节点
28-
- 🛡️ `系统网络检查`迁移至国内腾讯BGP节点
29-
-`时间同步服务器`迁移至国内公共节点
30-
- 🏫 `镜像拉取服务`迁移至国内腾讯BGP节点
31-
- 🔄 `OTA升级服务`迁移至国内腾讯BGP节点
32-
-`系统下载地址`优化至国内腾讯BGP节点
33-
- 🐳 添加国内 [`docker.io`](https://github.com/dongyubin/DockerHub)镜像地址至系统
34-
- 📨 `后台自动错误报告`服务迁移至国内腾讯BGP节点
35-
36-
---
37-
38-
### ⚙️ 系统配置优化
39-
- 🕰️ 默认时区设置为 `Asia/Shanghai`
40-
- 📅 系统更新频率调整为`每月28日`定期更新
41-
- 📢 终端页面添加`服务器赞助信息`声明
29+
### 🚀 Network Speed-Up Optimizations
30+
- 🕵️‍♂️ `Version check service` relocated to a Tencent BGP node in China
31+
- 🛡️ `System connectivity check` migrated to a China Tencent BGP node
32+
-`Time synchronization server` switched to Mainland China public NTP servers
33+
- 🏫 `Image download service` uses Tencent BGP node in China
34+
- 🔄 `OTA update service` migrated to China Tencent BGP node
35+
-`System download URLs` optimized for China through Tencent BGP
36+
- 🐳 Integrated Mainland China [`docker.io`](https://github.com/dongyubin/DockerHub) mirror into the system
37+
- 📨 `Automatic error reporting service` now running via China Tencent BGP node
4238

4339
---
4440

45-
### 📦 加载项优化
46-
- ❌ 移除不稳定的 [`官方加载项源`](https://github.com/home-assistant/addons)
47-
- ❌ 移除不稳定的 [`官方社区源`](https://github.com/hassio-addons/repository)
48-
- ❌ 移除不稳定的 [`Music Assistant 源`](https://github.com/music-assistant/home-assistant-addon)
49-
- ❌ 移除不稳定的 [`ESP Home 源`](https://github.com/esphome/home-assistant-addon)
50-
- ✅ 添加经过全面优化与汉化的[`加载项源`](https://gitee.com/desmond_GT/hassio-addons/blob/main/README.md)为默认加载项源(上述移除内容均已包含在内)
41+
### ⚙️ System Configuration Enhancements
42+
- 🕰️ Default time zone set to `Asia/Shanghai`
43+
- 📅 System automatically updates on the 28th of each month
44+
- 📢 Terminal page now displays server sponsorship information
5145

5246
---
5347

54-
### 🤖 智能安装体验
55-
- 🚦 系统启动时**自动**检测网络并安装 ![](https://img.shields.io/badge/HACS-%E6%9E%81%E9%80%9F%E7%89%88-41BDF5?style=for-the-badge&logo=home-assistant&logoColor=white)
56-
> 为了让更多人体验极速版,欢迎愿意共享 Token 的朋友[点击链接](https://tokenhub.hacs.vip/)共享
48+
### 📦 Add-ons Optimization
49+
- ❌ Removed unstable [`Official Add-ons`](https://github.com/home-assistant/addons) repository
50+
- ❌ Removed unstable [`Official Community`](https://github.com/hassio-addons/repository) repository
51+
- ❌ Removed unstable [`Music Assistant`](https://github.com/music-assistant/home-assistant-addon) repository
52+
- ❌ Removed unstable [`ESP Home`](https://github.com/esphome/home-assistant-addon) repository
53+
- ✅ Added a fully optimized and localized [`Add-ons source`](https://gitee.com/desmond_GT/hassio-addons/blob/main/README.md) as the default add-ons repository (including all of the above removals)
5754

5855
---
5956

60-
> 🚀 *专为中国用户优化加速的 Home Assistant OS*
61-
62-
- 🔧 保持系统原生体验,所有更改仅为提速优化以及合规性。
63-
- 🛡️ **所有个人或者商家均可免费使用此产品(愿意赞助的朋友可以扫下面二维码)**
64-
- 🛠️ 每月**27日****GitHub Actions** 自动构建最新版。
65-
- ⭐ 如果觉得有帮助,欢迎点个 Star 支持!
57+
### 🤖 Intelligent Installation Experience
58+
- 🚦 On system startup, **automatically** detects the network and installs ![HACS-China](https://img.shields.io/badge/HACS-China-41BDF5?style=for-the-badge&logo=home-assistant&logoColor=white)
59+
> To help more users experience Turbo Edition, friends willing to share a Token are welcome to [share here](https://tokenhub.hacs.vip/)
6660
6761
---
6862

69-
### 🚦 速度演示
70-
71-
- [初始化速度演示](https://www.bilibili.com/video/BV1tr7VzCE35/?share_source=copy_web&vd_source=9b5dc5e48277a13da484e0352d3707e9)
72-
> 家庭宽带:1G约1~1.5分钟,500M约3分钟,100M约5分钟
63+
> 🚀 *A Home Assistant OS specifically optimized and accelerated for users in China*
7364
74-
- [升级速度演示](https://www.bilibili.com/video/BV1judBY2ES7?t=82.3)
75-
> 升级速度与初始化类似
65+
- 🔧 Maintains the official system experience; all adjustments are solely for acceleration and compliance.
66+
- 🛡️ **Free for all individuals and businesses (if you'd like to support the project, please scan the QR code below!)**
67+
- 🛠️ The newest version is automatically built **on the 27th of every month** by **GitHub Actions**
68+
- ⭐ If you find this helpful, please consider giving the project a Star!
7669

7770
---
7871

72+
### 🚦 Speed Demonstration
7973

74+
- [Initialization Speed Demonstration](https://www.bilibili.com/video/BV1tr7VzCE35/?share_source=copy_web&vd_source=9b5dc5e48277a13da484e0352d3707e9)
75+
> Download Bandwidth: 1Gbps about 1~1.5 minutes, 500Mbps around 3 minutes, 100Mbps about 5 minutes
8076
81-
## 官方信息
77+
- [Upgrade Speed Demonstration](https://www.bilibili.com/video/BV1judBY2ES7?t=82.3)
78+
> Upgrade speed is similar to initialization
8279
83-
- 🌐 官方网站:[https://www.hasscn.top](https://www.hasscn.top)
8480

85-
- 📱 官方公众号
81+
---
8682

87-
<div align="left">
88-
<img src="./img/WeChat_QRCode.png" alt="关注我" width="400"/>
89-
</div>
83+
Thank you for your attention and support! If you have any questions, feel free to reach out anytime.
9084

85+
- **Panther x2 (panther_x2)** adaptation source: [https://github.com/jianyun8023/operating-system](https://github.com/jianyun8023/operating-system)
86+
- **Sonoff iHost** adaptation source: [https://github.com/iHost-Open-Source-Project/ha-operating-system](https://github.com/iHost-Open-Source-Project/ha-operating-system)
87+
- **Orangepi CM4 (v1.3.1)** adaptation source: [https://github.com/hhuangpeiqi/home-assistant-OS](https://github.com/hhuangpeiqi/home-assistant-OS)
88+
> Hardware version v1.3.1 is verified; version v1.4 is not supported.
9189
---
9290

93-
感谢您的关注与支持!如有疑问,欢迎随时联系我。
9491

95-
- **黑豹x2(panther_x2)** 适配来源:[https://github.com/jianyun8023/operating-system](https://github.com/jianyun8023/operating-system)
96-
- **Sonoff iHost** 适配来源:[https://github.com/iHost-Open-Source-Project/ha-operating-system](https://github.com/iHost-Open-Source-Project/ha-operating-system)
97-
- **Orangepi CM4(v1.3.1)** 适配来源:[https://github.com/hhuangpeiqi/home-assistant-OS](https://github.com/hhuangpeiqi/home-assistant-OS)
98-
> 已验证硬件版本v1.3.1,确认v1.4的硬件版本无法使用
99-
---
92+
Thank you again for your understanding and support! 🙏
10093

94+
## 🖥️ Device Adaptation Contributions Welcome
10195

96+
🎉 Thank you for your willingness to contribute device adaptations to HAOS! To ensure user safety and system stability, all submitted code will be carefully reviewed. Thank you for your cooperation.
10297

98+
⚠️ As the official team is gradually phasing out devices with arm32 architecture, only x86_64 and aarch64 device adaptations are generally accepted (device manufacturers may discuss exceptions).
10399

100+
## 📝 PR Submission Guidelines
104101

105-
## ☕ 如果你觉得本项目对你有帮助
102+
To keep the project structure organized and ensure smooth multi-device compilations, please adhere to these guidelines:
106103

107-
- 欢迎请我喝杯咖啡~
104+
### 📂 Directory Structure Requirements
105+
- 🗂️ **Device configuration directories**
106+
Place them under `buildroot-external\board\`
107+
- 📍 Direct placement, e.g.: `board\orangepi_CM4`
108+
- 🏷️ Brand subdirectory, e.g.: `board\orangepi\computer_model4`
108109

110+
- ⚙️ **Build configuration files**
111+
Place all defconfig files in `buildroot-external\config`
112+
Example: `orangepi_cm4_deconfig`
109113

110-
| 微信支持 | 支付宝支持 |
111-
|----------|------------|
112-
| ![微信](./img/WeChat_Pay.jpg) | ![支付宝](./img/Ali_Pay.jpg) |
114+
- 📦 **Additional packages**
115+
Any extra packages should be added to the `packages` directory, one folder per package
113116

114-
> 名单公示在[此页面上](https://www.hasscn.top/sponsor.html#-%E7%89%B9%E5%88%AB%E9%B8%A3%E8%B0%A2)
117+
-**For files outside these directories**
118+
Please provide clear reasons in your submission
115119

120+
## ⚡ Important Reminders
121+
1. 🚫 Do NOT edit HAOS official source files or other directories
122+
2. 🚫 Do NOT create directories outside those specified above
123+
3. 🔍 If there are questions regarding your code or your PR lacks sufficient description, you may be contacted for clarification
124+
4. ❌ Code submissions that cannot be reasonably explained will not be merged
116125

117-
感谢您的理解与支持! 🙏
126+
🤝 We look forward to building a better HAOS ecosystem in China together!
118127

119-
## 🖥️ 欢迎参与机型适配
128+
🐛 If there are bugs or questions about the firmware you submit, please help respond in the issues area. Thank you very much!
129+
130+
---
120131

121-
🎉 首先,衷心感谢您愿意为 HAOS 贡献机型适配!为确保用户使用安全及系统稳定性,我们将对提交的代码进行严格审核,敬请理解。
122132

123-
⚠️ 因官方开始淘汰 arm32 架构的设备,原则上只接受 x86_64 和 aarch64 的设备适配,厂家设备可协商
133+
## Official Information
124134

125-
## 📝 提交规范说明
135+
- 🌐 Official Website: [https://www.hasscn.top](https://www.hasscn.top)
126136

127-
为保持项目结构清晰,避免多机型编译时出现混乱,请遵循以下规范:
137+
- 📱 Official WeChat Public Account
128138

129-
### 📂 目录结构要求
130-
- 🗂️ **机型配置目录**
131-
统一放置于 `buildroot-external\board\` 目录下
132-
- 📍 直接放置,如:`board\orangepi_CM4`
133-
- 🏷️ 按品牌分类,如:`board\orangepi\computer_model4`
139+
<div align="left">
140+
<img src="./img/WeChat_QRCode.png" alt="Follow me" width="400"/>
141+
</div>
134142

135-
- ⚙️ **编译配置文件**
136-
所有 defconfig 文件请放入 `buildroot-external\config` 目录
137-
示例:`orangepi_cm4_deconfig`
138143

139-
- 📦 **额外软件包**
140-
如需添加额外软件包,请统一放置于 `packages` 目录下,并确保一个软件包对应一个独立目录
144+
## ☕ If you find this project helpful
141145

142-
-**非指定目录文件**
143-
提交的时候请一定说清楚原因
146+
- Feel free to buy me a coffee~
144147

145-
## ⚡ 重要注意事项
146-
1. 🚫 禁止修改 HAOS 官方源文件及其他目录
147-
2. 🚫 禁止创建非规范要求的额外目录
148-
3. 🔍 对于存在疑问的代码,如果提交时描述不够清楚我可能将与您沟通确认其作用
149-
4. ❌ 无法合理解释的代码将不予合并
150148

151-
🤝 我们期待与您共同打造更完善的 HAOS 生态!
149+
| WeChat | Alipay |
150+
|--------|--------|
151+
| ![WeChat](./img/WeChat_Pay.jpg) | ![Alipay](./img/Ali_Pay.jpg) |
152152

153-
🐛 如果用户对于您提交的固件有 bug 或者有疑问,还需要您在 issue 区帮忙回复,万分感谢!
153+
> The donor list is published [on this page](https://www.hasscn.top/sponsor.html#-%E7%89%B9%E5%88%AB%E9%B8%A3%E8%B0%A2)

0 commit comments

Comments
 (0)