okooooooo/UniXNU
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: keep the README to the project, links and repositories

Browse Source
This commit is contained in:
UniXNU Docs committed 2026-10-25 06:39:00 +08:00
1 parent 2ed313fd5f
commit 2b039d34cc
2 files changed
+17 -97
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.md
+8 -50
View File
@@ -19,66 +19,24 @@
# UniXNU
> **Migration notice:** Update your device repository for shared SoC support and canonical component names. Follow the [migration guide](https://unixnu.com/porting/migration).
Run iOS and macOS on non-Apple ARM64 hardware through UEFI.
An independent project to run iOS and macOS on non-Apple ARM64 hardware through UEFI.
UniXNU provides shared build tools, ARM64 support, OS profiles and reusable components for ports across SoCs and devices. SoC repositories supply common platform support, and device repositories supply board configuration and hardware integration.
**🎉 News:** Adreno740 and AdrenoMetal provide GPU acceleration on sheng. The render server composites the system UI through the Adreno 740, and listed processes get their own Metal devices. These components are shared GPU implementations; each device port supplies the required firmware, power, memory and display integration. See the [Adreno 740 driver documentation](https://unixnu.com/drivers/adreno740).
## Firmware requirement
Build the device firmware with `./unixnu build firmware --uefi ../uefi-<device>` before `./unixnu bootimg`. Include UniXNU, UniXNUDxe, DarwinBoot and the shared `UniXNURamDiskDxe` payload driver in the firmware. Follow the [required firmware integration](https://unixnu.com/porting/uefi-firmware#required-integration).
Save paths and boot arguments in [`unixnu.local.toml`](https://unixnu.com/reference/configuration#local-build-inputs) to run `./unixnu kernel`, `./unixnu firmware`, `./unixnu payload`, and `./unixnu bootimg`. After changing boot arguments, rebuild the payload and boot image. See [boot arguments](https://unixnu.com/xnu/boot-arguments#apply-arguments) and [green-bar diagnosis](https://unixnu.com/guide/debugging#green-bar).
## Documentation
Follow [Port a device](https://unixnu.com/porting/) in order, including the [driver adaptation checklist](https://unixnu.com/porting/drivers) for platform, storage, display, brightness, input, GPU, Wi-Fi, audio and power.
Linux setup supports apt, dnf, pacman and zypper, plus environments with dependencies installed separately. See [Linux requirements](https://unixnu.com/guide/requirements#linux).
The documentation is at [unixnu.com](https://unixnu.com). Its sources, navigation, translations, assets, configuration, and deployment workflow are maintained in this repository. It covers the boot chain, the build driver, device porting, driver development, the 4 KiB XNU page patches, boot arguments and per-device notes.
- [Port a device](https://unixnu.com/porting/)
- [Build and boot](https://unixnu.com/building)
- [Devices](https://unixnu.com/devices/)
- [Technical reference](https://unixnu.com/reference/)
Documentation: [unixnu.com](https://unixnu.com). Start with [Port a device](https://unixnu.com/porting/) or [Build and boot](https://unixnu.com/building).
## Repositories
| Repository | Contents |
| --- | --- |
| [UniXNU](https://github.com/UniXNU/UniXNU) | Build tools, component catalog, ARM64 support, OS profiles, templates, UEFI package and documentation site |
| [UniXNU-sm8550-common](https://github.com/UniXNU/UniXNU-sm8550-common) | Shared SM8550 configuration, DTSI, platform operations and patch series |
| [UniXNU-sheng](https://github.com/UniXNU/UniXNU-sheng) | Device repository for the Xiaomi Pad 6S Pro |
| [uefi-sheng](https://github.com/UniXNU/uefi-sheng) | UEFI firmware port for the Xiaomi Pad 6S Pro |
| [UniXNU](https://github.com/UniXNU/UniXNU) | Build tools, component catalog, ARM64 support, OS profiles, UEFI package, documentation |
| [UniXNU-sm8550-common](https://github.com/UniXNU/UniXNU-sm8550-common) | Shared SM8550 support |
| [UniXNU-sheng](https://github.com/UniXNU/UniXNU-sheng) | Xiaomi Pad 6S Pro |
| [uefi-sheng](https://github.com/UniXNU/uefi-sheng) | UEFI firmware for the Xiaomi Pad 6S Pro |
The main checkout contains shared drivers and kits. Device repositories own their board driver submodules; sheng supplies ShengUfs and ShengHidInput alongside its touch and preflight components. The catalog describes available components, and the build tools assemble the selected device sources. Clone repositories with `--recurse-submodules`.
Device repositories select pinned SoC sources, OS profiles, and components. The build tools merge the profiles, resolve dependencies, compile the board DTS, and generate the ADT. Start with [AGENTS.md](AGENTS.md), [the device template](examples/device/README.md), and [the migration guide](https://unixnu.com/porting/migration).
## Official device development
Every official device maintains `porting.toml` with hardware inputs, configuration,
procedures, findings, evidence and completion criteria for each subsystem.
Maintainers and agents use this record. The site renders it from the device
revision pinned in `devices.toml`.
The required CI check covers the record structure, component dependencies and
updates to findings or evidence for changed code. Start with the
[record guide](https://unixnu.com/porting/records),
[UFS porting guide](https://unixnu.com/porting/ufs) and
[device template](examples/device/README.md).
Clone with `--recurse-submodules`.
## Contributing
Read [CONTRIBUTING.md](CONTRIBUTING.md) for the repository scope, the development workflow, the commit format and the documentation rules.
## Private blobs
Do not add Apple IPSW files, kernelcaches, disk images, trust caches, Data seeds or vendor firmware to this repository. Keep them in a local cache or external storage.
See [CONTRIBUTING.md](CONTRIBUTING.md).
## License
README.zh-CN.md
+9 -47
View File
@@ -19,63 +19,25 @@
# UniXNU
> **迁移通知：** 请按[迁移指南](https://unixnu.com/zh/porting/migration)更新设备仓库，接入共享 SoC 支持并统一组件名称。
通过 UEFI 在非 Apple ARM64 硬件上运行 iOS 与 macOS。
一个独立项目，通过 UEFI 在非 Apple ARM64 硬件上运行 iOS 与 macOS。
UniXNU 为不同 SoC 和设备的移植提供共享构建工具、ARM64 支持、OS 配置和可复用组件。SoC 仓库提供公共平台支持，设备仓库提供板级配置和硬件集成。
**🎉 News:** Adreno740 和 AdrenoMetal 在 sheng 上提供 GPU 加速。render server 通过 Adreno 740 合成系统界面，列入白名单的进程会获得各自的 Metal 设备。这两个组件提供共享 GPU 实现，各设备适配提供所需的固件、电源、内存和显示集成。详见 [Adreno 740 驱动文档](https://unixnu.com/zh/drivers/adreno740)。
## 固件要求
运行 `./unixnu bootimg` 前，先用 `./unixnu build firmware --uefi ../uefi-<device>` 构建设备固件，并将 UniXNU、UniXNUDxe、DarwinBoot 和共享负载驱动 `UniXNURamDiskDxe` 纳入固件。步骤见[必需的固件集成](https://unixnu.com/zh/porting/uefi-firmware#required-integration)。
在 [`unixnu.local.toml`](https://unixnu.com/zh/reference/configuration#local-build-inputs) 保存路径和启动参数，即可使用 `./unixnu kernel`、`./unixnu firmware`、`./unixnu payload` 和 `./unixnu bootimg`。修改启动参数后重新构建负载和启动镜像。检查步骤见[启动参数](https://unixnu.com/zh/xnu/boot-arguments#apply-arguments)和[绿条诊断](https://unixnu.com/zh/guide/debugging#green-bar)。
## 文档
按[设备移植流程](https://unixnu.com/zh/porting/)逐步操作，并完成[驱动适配清单](https://unixnu.com/zh/porting/drivers)中的平台、存储、显示、亮度、输入、GPU、Wi-Fi、音频和电源适配。
Linux 安装脚本支持 apt、dnf、pacman、zypper，以及单独准备依赖的环境。详见 [Linux 要求](https://unixnu.com/zh/guide/requirements#linux)。
文档位于 [unixnu.com](https://unixnu.com)，源码、导航、翻译、资源、配置和部署工作流由本仓库维护。文档覆盖启动链、构建驱动、设备移植、驱动开发、XNU 4 KiB 页补丁、启动参数和设备说明。
- [移植设备](https://unixnu.com/zh/porting/)
- [构建与启动](https://unixnu.com/zh/building)
- [设备](https://unixnu.com/zh/devices/)
- [技术参考](https://unixnu.com/zh/reference/)
文档：[unixnu.com](https://unixnu.com/zh/)。从[移植设备](https://unixnu.com/zh/porting/)或[构建与启动](https://unixnu.com/zh/building)开始。
## 仓库
| 仓库 | 内容 |
| --- | --- |
| [UniXNU](https://github.com/UniXNU/UniXNU) | 构建工具、组件目录、ARM64 支持、OS 配置、模板、UEFI package 和文档站 |
| [UniXNU-sm8550-common](https://github.com/UniXNU/UniXNU-sm8550-common) | SM8550 共享配置、DTSI、平台操作和补丁系列 |
| [UniXNU-sheng](https://github.com/UniXNU/UniXNU-sheng) | 小米平板 6S Pro 的设备仓库 |
| [uefi-sheng](https://github.com/UniXNU/uefi-sheng) | 小米平板 6S Pro 的 UEFI 固件移植 |
| [UniXNU](https://github.com/UniXNU/UniXNU) | 构建工具、组件目录、ARM64 支持、OS 配置、UEFI package、文档 |
| [UniXNU-sm8550-common](https://github.com/UniXNU/UniXNU-sm8550-common) | SM8550 共享支持 |
| [UniXNU-sheng](https://github.com/UniXNU/UniXNU-sheng) | 小米平板 6S Pro |
| [uefi-sheng](https://github.com/UniXNU/uefi-sheng) | 小米平板 6S Pro 的 UEFI 固件 |
主仓库检出共享驱动和 kit。设备仓库维护板级驱动子模块，sheng 提供 ShengUfs、ShengHidInput、触控和 preflight 组件。组件目录描述可用组件，构建工具组装所选设备的源码。克隆仓库时使用 `--recurse-submodules`。
设备仓库选择固定版本的 SoC 源码、OS 配置和组件。构建工具合并配置、解析依赖、编译板级 DTS 并生成 ADT。先读 [AGENTS.md](AGENTS.md)、[设备模板](examples/device/README.md)和[迁移指南](https://unixnu.com/zh/porting/migration)。
## 官方设备开发
每个官方设备维护 `porting.toml`，为每个子系统记录硬件输入、配置、步骤、经验、
证据和完成条件。维护者与 agent 共用这份记录。文档站按 `devices.toml` 固定的设备版本生成页面。
必需 CI 检查覆盖记录结构、组件依赖，以及代码改动对应部分的经验或证据更新。
从[记录指南](https://unixnu.com/zh/porting/records)、[UFS 移植指南](https://unixnu.com/zh/porting/ufs)
和[设备模板](examples/device/README.md)开始。
克隆时使用 `--recurse-submodules`。
## 参与贡献
阅读 [CONTRIBUTING.md](CONTRIBUTING.md)（英文），或查看[文档站的贡献页面](https://unixnu.com/zh/contributing/documentation)。
## 私有 blob
不要把 Apple IPSW、kernelcache、磁盘镜像、trust cache、Data 种子或厂商固件提交到本仓库。把它们放在本地缓存或外部存储。
见 [CONTRIBUTING.md](CONTRIBUTING.md)。
## 许可证
BSD-2-Clause-Patent。见 [LICENSE](LICENSE)。
BSD-2-Clause-Patent，见 [LICENSE](LICENSE)。