From 7e76929d2ed79d74e754dd535d5e26080c4bdeb5 Mon Sep 17 00:00:00 2001 From: zhukang <274546966@qq.com> Date: Thu, 12 Mar 2026 15:22:50 +0800 Subject: [PATCH] docs: add bilingual readme and contact info --- README.md | 25 ++++++++ README.zh-CN.md | 154 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 179 insertions(+) create mode 100644 README.zh-CN.md diff --git a/README.md b/README.md index d96b0ee..af7357f 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,10 @@

Explainable, recovery-first Mac maintenance workspace.

+

+ English | 简体中文 +

+

Atlas for Mac overview screen

@@ -12,6 +16,10 @@ Atlas for Mac is a native macOS application for people who need to understand wh This repository is the working source for the new Atlas for Mac product. Atlas for Mac itself is open source under the MIT License. It remains an independent project and may reuse selected upstream Mole capabilities under the MIT License, but user-facing naming, release materials, and product direction are Atlas-first. +## Disclaimer + +Atlas for Mac is an independent open-source project. It is not affiliated with, endorsed by, or sponsored by Apple, the upstream Mole authors, or any other commercial Mac utility vendor. Some components in this repository may reuse or adapt upstream Mole code under the MIT License; when such code ships, the related attribution and third-party notices must remain available. Cleanup, uninstall, and recovery actions can affect local files, caches, and app data, so review findings and recovery options before execution. + ## Installation ### Download @@ -124,6 +132,23 @@ swift test --package-path Apps This exports the configured app icon and current app-shell screenshots into `Docs/Media/README/`. +## Author & Contact + +- Developer: `Lizi KK` +- Role: `Ex-Baidu & Alibaba Tech Lead · atomstorm.ai Founder` +- Website: [AtomStorm Studio](https://studio.atomstorm.ai) +- X (Twitter): [x.com/lizikk_zhu](https://x.com/lizikk_zhu) +- Discord: [discord.gg/aR2kF8Xman](https://discord.gg/aR2kF8Xman) +- GitHub Repository: [CSZHK/CleanMyPc](https://github.com/CSZHK/CleanMyPc) +- Issues: [github.com/CSZHK/CleanMyPc/issues](https://github.com/CSZHK/CleanMyPc/issues) +- Security Contact: `cszhk0310@gmail.com` for private vulnerability reports. See [SECURITY.md](SECURITY.md). + +### More Socials + +| WeChat Official Account | Xiaohongshu | +| --- | --- | +| ![WeChat Official Account QR code](Packages/AtlasFeaturesAbout/Sources/AtlasFeaturesAbout/Resources/Media.xcassets/qrcode-wechat.imageset/qrcode-wechat.jpg) | ![Xiaohongshu QR code](Packages/AtlasFeaturesAbout/Sources/AtlasFeaturesAbout/Resources/Media.xcassets/qrcode-xiaohongshu.imageset/qrcode-xiaohongshu.jpg) | + ## Attribution Atlas for Mac is an independent MIT-licensed open-source project. This repository builds in part on the open-source project [Mole](https://github.com/tw93/mole) by tw93 and contributors, and still contains upstream Mole code and adapters used as implementation input. If upstream-derived code ships, keep [Docs/ATTRIBUTION.md](Docs/ATTRIBUTION.md) and [Docs/THIRD_PARTY_NOTICES.md](Docs/THIRD_PARTY_NOTICES.md) in sync with shipped artifacts. diff --git a/README.zh-CN.md b/README.zh-CN.md new file mode 100644 index 0000000..2a603e2 --- /dev/null +++ b/README.zh-CN.md @@ -0,0 +1,154 @@ +
+ Atlas for Mac 图标 +

Atlas for Mac

+

可解释、以恢复为先的 Mac 维护工作台。

+
+ +

+ English | 简体中文 +

+ +

+ Atlas for Mac 概览界面 +

+ +Atlas for Mac 是一款原生 macOS 应用，面向需要弄清楚 Mac 为什么变慢、磁盘为什么变满、系统为什么变得杂乱的用户，并在此基础上提供安全、可恢复的处理操作。当前 MVP 将系统概览、Smart Clean、应用卸载流程、权限指引、历史记录和恢复能力整合到一个桌面工作台中。 + +这个仓库是 Atlas for Mac 新产品的工作源码。Atlas for Mac 本身以 MIT License 开源发布。它是一个独立项目，可以在 MIT License 下复用部分上游 Mole 能力，但用户可见命名、发布材料和产品方向均以 Atlas 为主。 + +## 免责声明 + +Atlas for Mac 是一个独立的开源项目，与 Apple、Mole 上游作者或其他商业 Mac 工具厂商不存在隶属、赞助或背书关系。此仓库中的部分组件可能会在 MIT License 下复用或改造上游 Mole 代码；如果这些代码随产品一起发布，相关归因和第三方许可声明必须保留。清理、卸载和恢复类操作可能影响本地文件、缓存和应用数据，因此在执行前请先检查发现结果和恢复选项。 + +## 安装 + +### 下载 + +请从 [Releases](https://github.com/CSZHK/CleanMyPc/releases) 页面下载最新版本： + +- **`.dmg`** - 推荐。打开磁盘镜像后，将 Atlas 拖入 Applications 文件夹。 +- **`.zip`** - 解压后将 Atlas.app 移动到 Applications 文件夹。 +- **`.pkg`** - 运行安装包，按向导完成安装。 + +### 系统要求 + +- macOS 14.0（Sonoma）或更高版本 +- Apple Silicon 或 Intel Mac + +### 从源码构建 + +```bash +git clone https://github.com/CSZHK/CleanMyPc.git +cd CleanMyPc +swift run --package-path Apps AtlasApp +``` + +或者使用 Xcode 打开： + +```bash +brew install xcodegen +xcodegen generate +open Atlas.xcodeproj +``` + +> **说明**：应用当前尚未签名。首次启动时，你可能需要右键点击应用并选择“打开”以绕过 Gatekeeper，或前往“系统设置 > 隐私与安全性”手动允许启动。 + +## MVP 模块 + +- `Overview` +- `Smart Clean` +- `Apps` +- `History` +- `Recovery` +- `Permissions` +- `Settings` + +## 产品原则 + +- 执行前先解释推荐原因。 +- 优先提供可恢复的操作，而不是永久删除。 +- 权限请求遵循最小权限并结合具体上下文。 +- 保持原生 macOS 应用外壳，并明确 worker 与 helper 边界。 +- 同时支持 `简体中文` 和 `English`，其中 `简体中文` 为应用默认语言。 + +## 界面截图 + +| Overview | Smart Clean | +| --- | --- | +| ![Overview](Docs/Media/README/atlas-overview.png) | ![Smart Clean](Docs/Media/README/atlas-smart-clean.png) | + +| Apps | History | +| --- | --- | +| ![Apps](Docs/Media/README/atlas-apps.png) | ![History](Docs/Media/README/atlas-history.png) | + +## 仓库结构 + +- `Apps/` - macOS 应用 target 与面向应用层的入口 +- `Packages/` - 共享的 domain、application、design system、protocol 和 feature packages +- `XPC/` - worker service targets +- `Helpers/` - 特权 helper targets +- `Testing/` - 共享测试支持与 UI 自动化复现 targets +- `Docs/` - 产品、架构、规划、归因和执行文档 + +## 本地开发 + +### 运行应用 + +```bash +swift run --package-path Apps AtlasApp +``` + +### 打开原生 Xcode 工程 + +```bash +xcodegen generate +open Atlas.xcodeproj +``` + +### 构建原生应用包 + +```bash +./scripts/atlas/build-native.sh +``` + +### 打包 `.zip`、`.dmg` 和 `.pkg` 产物 + +```bash +./scripts/atlas/package-native.sh +``` + +### 运行聚焦测试 + +```bash +swift test --package-path Packages +swift test --package-path Apps +``` + +## 刷新 README 媒体资源 + +```bash +./scripts/atlas/export-readme-assets.sh +``` + +该脚本会将当前配置的应用图标和应用外壳截图导出到 `Docs/Media/README/`。 + +## 作者与联系 + +- 开发者：`Lizi KK` +- 身份：`前百度 & 阿里技术负责人 · atomstorm.ai 创始人` +- 官网：[AtomStorm Studio](https://studio.atomstorm.ai) +- X（Twitter）：[x.com/lizikk_zhu](https://x.com/lizikk_zhu) +- Discord：[discord.gg/aR2kF8Xman](https://discord.gg/aR2kF8Xman) +- GitHub 仓库：[CSZHK/CleanMyPc](https://github.com/CSZHK/CleanMyPc) +- 问题反馈：[github.com/CSZHK/CleanMyPc/issues](https://github.com/CSZHK/CleanMyPc/issues) +- 安全联系：`cszhk0310@gmail.com`，仅用于私下报告安全漏洞。详见 [SECURITY.md](SECURITY.md)。 + +### 更多社媒 + +| 微信公众号 | 小红书 | +| --- | --- | +| ![微信公众号二维码](Packages/AtlasFeaturesAbout/Sources/AtlasFeaturesAbout/Resources/Media.xcassets/qrcode-wechat.imageset/qrcode-wechat.jpg) | ![小红书二维码](Packages/AtlasFeaturesAbout/Sources/AtlasFeaturesAbout/Resources/Media.xcassets/qrcode-xiaohongshu.imageset/qrcode-xiaohongshu.jpg) | + +## 归因 + +Atlas for Mac 是一个独立的、基于 MIT License 发布的开源项目。此仓库部分构建工作基于开源项目 [Mole](https://github.com/tw93/mole)（由 tw93 和贡献者维护），并且当前仍包含作为实现输入的上游 Mole 代码和适配器。如果发布中包含上游衍生代码，请保持 [Docs/ATTRIBUTION.md](Docs/ATTRIBUTION.md) 和 [Docs/THIRD_PARTY_NOTICES.md](Docs/THIRD_PARTY_NOTICES.md) 与实际交付产物同步。