Skip to content

Commit bf7ebb3

Browse files
committed
Polish XFXCode Project public README
1 parent 57ab229 commit bf7ebb3

2 files changed

Lines changed: 158 additions & 38 deletions

File tree

README.md

Lines changed: 158 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,69 @@
1-
# XFXCode Project
1+
<p align="center">
2+
<img src="./assets/xfxcode-icon.png" width="104" height="104" alt="XFXCode icon" />
3+
</p>
24

3-
XFXCode Project 是 XFXCode 的公开下载与发布说明仓库。这里只发布下载说明、Release notes、安装包和校验值,不包含 XFXCode 源码。
5+
<h1 align="center">XFXCode Project</h1>
46

5-
Latest release:
7+
<p align="center">
8+
<strong>专为上海市民办新复兴初级中学开发的 AI IDE</strong>
9+
</p>
610

7-
https://github.com/EazyLee30/xfxcode-project/releases/latest
11+
<p align="center">
12+
面向校园创新教育、AI 编程实践、项目制学习和真实代码创作的桌面级智能开发环境。
13+
</p>
14+
15+
<p align="center">
16+
<a href="https://github.com/EazyLee30/xfxcode-project/releases/latest"><strong>Download Latest Release</strong></a>
17+
·
18+
<a href="#快速开始">快速开始</a>
19+
·
20+
<a href="#核心能力">核心能力</a>
21+
·
22+
<a href="#校验下载文件">校验文件</a>
23+
</p>
24+
25+
<p align="center">
26+
<img alt="Release" src="https://img.shields.io/github/v/release/EazyLee30/xfxcode-project?style=for-the-badge&label=release" />
27+
<img alt="Windows" src="https://img.shields.io/badge/Windows-Portable_EXE-1677ff?style=for-the-badge&logo=windows11&logoColor=white" />
28+
<img alt="macOS" src="https://img.shields.io/badge/macOS-Apple_Silicon-111111?style=for-the-badge&logo=apple&logoColor=white" />
29+
<img alt="DeepSeek" src="https://img.shields.io/badge/DeepSeek_V4-Agent_Harness-00A67E?style=for-the-badge" />
30+
</p>
31+
32+
---
33+
34+
## 项目定位
835

9-
> Download the `.exe` or `.dmg` asset from Releases. GitHub automatically shows `Source code (zip)` and `Source code (tar.gz)` for every release tag; those archives only contain this public download repository, not the private XFXCode application source code.
36+
XFXCode Project 是 XFXCode 的公开下载与发布说明仓库。XFXCode 是一款专为 **上海市民办新复兴初级中学** 打造的 AI IDE:它把传统代码编辑器、AI Agent、工具调用、项目文件操作、技能系统和治理审计整合在一个桌面应用中,让学生和教师可以在真实工程环境里完成 AI 辅助编程、作品创作和代码学习。
37+
38+
它不是一个普通聊天机器人,也不是简单套壳网页。XFXCode 的设计目标是让 AI 真正进入“读代码、改代码、跑命令、看结果、可撤销、可审查”的完整学习闭环。
39+
40+
> 本仓库只提供公开下载、Release notes、安装包和校验值,不包含 XFXCode 私有源码。
41+
42+
## 一句话介绍
43+
44+
| 维度 | XFXCode 提供的能力 |
45+
| --- | --- |
46+
| 面向对象 | 上海市民办新复兴初级中学的 AI 编程教学与创新项目实践 |
47+
| 产品形态 | Windows / macOS 桌面 AI IDE |
48+
| AI 能力 | DeepSeek V4 Flash / Pro、Agent Harness、工具调用、Skills |
49+
| 学习场景 | Python / Web / 项目制学习 / 代码讲解 / 自动修改 / 作品打磨 |
50+
| 管理边界 | 文件变更可见、工具步骤可追踪、危险操作可确认、下载包可校验 |
1051

1152
## 下载
1253

13-
- Windows x64 免安装版:`XFXCode_<version>_x64-portable.exe`
14-
- macOS Apple Silicon:`XFXCode_<version>_aarch64.dmg`
54+
最新版本:
1555

16-
不要下载 GitHub 自动生成的 `Source code (zip)` / `Source code (tar.gz)` 来安装 XFXCode。它们只是本公开下载仓库的快照,不是应用源码,也不是安装包。
56+
https://github.com/EazyLee30/xfxcode-project/releases/latest
1757

18-
Windows 版本是 portable EXE,下载后双击运行,不需要 setup,不需要安装向导。
58+
| 平台 | 文件 | 说明 |
59+
| --- | --- | --- |
60+
| Windows x64 | `XFXCode_<version>_x64-portable.exe` | 免安装 portable EXE,下载后双击运行 |
61+
| macOS Apple Silicon | `XFXCode_<version>_aarch64.dmg` | 打开 DMG 后拖入 Applications |
62+
| 校验值 | `SHA256SUMS.txt` | 用于确认下载文件未损坏、未被替换 |
1963

20-
## 安装
64+
**不要下载** GitHub 自动生成的 `Source code (zip)` / `Source code (tar.gz)` 来安装 XFXCode。它们只是本公开下载仓库的快照,不是应用源码,也不是安装包。
65+
66+
## 快速开始
2167

2268
### Windows
2369

@@ -26,38 +72,114 @@ Windows 版本是 portable EXE,下载后双击运行,不需要 setup,不
2672
3. 双击运行。
2773
4. 如果 Windows SmartScreen 提示未知发布者,请确认文件来自本仓库官方 Release 页面后,再选择“更多信息 / 仍要运行”。
2874

75+
Windows 版本是 portable EXE,不需要 setup,不需要管理员安装,不进入安装向导。
76+
2977
### macOS
3078

3179
1. 打开最新 Release。
3280
2. 下载 `XFXCode_<version>_aarch64.dmg`
3381
3. 打开 DMG,把 XFXCode 拖到 Applications。
34-
4. 如果 macOS 首次启动时拦截,在“系统设置 > 隐私与安全性”里允许打开。
82+
4. 如果首次启动被 macOS 拦截,在“系统设置 > 隐私与安全性”里允许打开。
3583

3684
当前 macOS 构建面向 Apple Silicon。
3785

3886
## 第一次使用
3987

4088
1. 启动 XFXCode。
41-
2. 点击“打开文件夹”,选择项目目录。
42-
3. 打开“设置”。
43-
4. 填入 DeepSeek API Key。
44-
5. 选择默认模型:
45-
- `deepseek-v4-flash`:日常快速编码。
46-
- `deepseek-v4-pro`:审查、合并、高风险推理任务。
47-
6. 使用 **Ask** 做只读理解和分析,使用 **Agent** 让 XFXCode 通过工具修改文件。
48-
49-
## 主要能力
50-
51-
- Monaco 多标签编辑器、资源管理器、终端、AI 面板、设置和技能中心。
52-
- DeepSeek V4 Flash / Pro 模型 profile。
53-
- Agent / Ask 双模式。
54-
- 文件读写、搜索、创建、移动、删除等工具调用。
55-
- 联网搜索和网页抓取工具。
56-
- Agent Skills:支持内置、本地、项目、ClawHub 和生成式技能。
57-
- DeepSeek V4 Agent Harness:stage-aware profile、tool choice、cache telemetry、governance trace。
58-
- 每条 Assistant 回复下方展示文件变更卡片,支持打开文件、复制、反馈、时间和安全撤销。
59-
60-
## 校验文件
89+
2. 点击“打开文件夹”,选择你的课程项目、练习项目或作品目录。
90+
3. 打开“设置”,填入 DeepSeek API Key。
91+
4. 选择默认模型:
92+
- `deepseek-v4-flash`:适合日常快速编码、问答、普通工具循环。
93+
- `deepseek-v4-pro`:适合审查、合并、高风险推理和复杂分析。
94+
5. 在 AI 面板中选择工作方式:
95+
- **Ask**:只读理解代码、解释知识点、定位问题。
96+
- **Agent**:允许 AI 调用工具修改项目文件。
97+
98+
API Key 会保存在本机设置中。请不要把 API Key 粘贴进聊天内容、项目源码或公开截图。
99+
100+
## 核心能力
101+
102+
### 1. 桌面级 IDE 体验
103+
104+
- Monaco 多标签代码编辑器。
105+
- 项目资源管理器。
106+
- 集成终端。
107+
- AI 面板与状态栏。
108+
- 设置中心和技能中心。
109+
- 支持 Ctrl / Command + 鼠标滚轮缩放编辑器字号。
110+
111+
### 2. DeepSeek V4 Agent Harness
112+
113+
XFXCode 针对 DeepSeek V4 做了专门的 Agent Harness 融合:
114+
115+
- `deepseek-v4-flash` 用于快速执行、定位、普通工具循环。
116+
- `deepseek-v4-pro` 用于审查、合并、高风险 replay 和复杂推理。
117+
- 支持 thinking / tool-call continuity。
118+
- 支持 stage-aware `tool_choice`
119+
- 支持 context cache telemetry。
120+
- 原生工具调用不稳定时,可切换 ReAct XML 手动工具解析 fallback。
121+
122+
### 3. Agent / Ask 双模式
123+
124+
| 模式 | 适合场景 | 文件修改 |
125+
| --- | --- | --- |
126+
| Ask | 解释代码、知识点讲解、查找问题、阅读项目 | 默认不主动修改 |
127+
| Agent | 实现功能、修复 bug、重构代码、生成页面、运行命令 | 可通过工具修改 |
128+
129+
这种设计很适合课堂环境:先让学生用 Ask 理解,再用 Agent 实践,最后 review 变更。
130+
131+
### 4. 文件变更可见、可追踪、可撤销
132+
133+
每条 Assistant 回复下方都会展示本轮变更:
134+
135+
- 修改了几个文件。
136+
- 每个文件的路径。
137+
- 新增 / 删除行数。
138+
- 点击打开文件。
139+
- 复制回答、反馈、查看时间。
140+
- 对可安全恢复的变更执行撤销。
141+
142+
新建文件、多文件撤销、不可撤销变更等风险操作会有更明确的提示,避免误操作。
143+
144+
### 5. Skills 能力系统
145+
146+
XFXCode 支持 Agent Skills,让 AI 按任务加载更专业的指令和资料:
147+
148+
- 内置 bundled skills。
149+
- 用户级 `~/.xfxcode/skills`
150+
- 项目级 `.xfxcode/skills`
151+
- `.agents/skills` / `.claude/skills`
152+
- ClawHub skills。
153+
- 本地导入、URL 导入、AI 生成的技能草稿。
154+
155+
这让 XFXCode 不只是“模型调用器”,而是可以逐步沉淀学校自己的课程技能、项目模板和知识库。
156+
157+
## 校园使用场景
158+
159+
| 场景 | 示例 |
160+
| --- | --- |
161+
| 编程入门 | 解释 Python / JavaScript 代码,指出变量、函数、循环和条件判断 |
162+
| 作品开发 | 生成网页、小游戏、数据展示页面、课程项目原型 |
163+
| 代码修复 | 读取报错、定位文件、修改代码、解释为什么这样改 |
164+
| 项目制学习 | 围绕一个作品目录持续迭代,保留文件结构和变更记录 |
165+
| 教师演示 | 用 Agent 展示“需求 -> 计划 -> 修改 -> 验证”的完整过程 |
166+
| AI 素养教育 | 让学生看到 AI 调用了什么工具、改了什么文件、哪些操作需要确认 |
167+
168+
## 安全与治理
169+
170+
XFXCode 的 AI 执行有明确边界:
171+
172+
- Ask 模式偏只读。
173+
- Agent 模式才允许写文件。
174+
- 工具调用过程可见。
175+
- 失败工具不会伪装成成功文件变更。
176+
- 大文件或无快照变更会标记为不可撤销。
177+
- 删除新建文件、多文件撤销等操作需要确认。
178+
- Governance trace 记录工具暴露、模型路由、缓存命中和 replay metadata。
179+
180+
AI 可以提升学习效率,但不替代学生理解。建议课堂和项目提交中保留 review、讲解和测试环节。
181+
182+
## 校验下载文件
61183

62184
Release 中会附带 checksum。你也可以手动计算:
63185

@@ -73,11 +195,11 @@ Windows PowerShell:
73195
Get-FileHash .\XFXCode_<version>_x64-portable.exe -Algorithm SHA256
74196
```
75197

76-
把输出和 Release 中的 checksum 对比即可。
198+
把输出和 Release 中的 `SHA256SUMS.txt` 对比即可。
77199

78200
## 源码与授权
79201

80-
本仓库是公开下载仓库,只包含说明和 Release 二进制,不包含 XFXCode 源码。
202+
本仓库是公开下载仓库,只包含说明、Release notes、安装包和校验值,不包含 XFXCode 源码。
81203

82204
XFXCode 当前是闭源 / 专有软件。除非另有书面许可:
83205

@@ -88,15 +210,13 @@ XFXCode 当前是闭源 / 专有软件。除非另有书面许可:
88210

89211
## English
90212

91-
This repository is the public XFXCode Project download and release-notes repository. It contains download instructions, Release notes, binaries, and checksums only. It does not contain the XFXCode source code.
213+
XFXCode Project is the public download and release-notes repository for XFXCode, a desktop AI IDE developed for Shanghai Xin Fuxing Private Junior High School.
92214

93-
XFXCode is a lightweight desktop AI IDE for agentic coding workflows. It helps you open a project, ask an AI agent to inspect and edit files, review file changes, and keep tool execution visible through governance traces.
215+
This repository contains download instructions, Release notes, binaries, and checksums only. It does not contain the private XFXCode application source code.
94216

95217
Available builds:
96218

97219
- Windows x64 portable EXE: `XFXCode_<version>_x64-portable.exe`
98220
- macOS Apple Silicon DMG: `XFXCode_<version>_aarch64.dmg`
99221

100-
The Windows build is portable. Download it and double-click the EXE. There is no setup installer.
101-
102-
XFXCode is currently proprietary / closed-source software. Public Release downloads do not grant permission to copy, modify, redistribute, resell, or relicense the source code.
222+
GitHub automatically adds `Source code (zip)` and `Source code (tar.gz)` to every release. Those archives are only snapshots of this public download repository. To install XFXCode, download the `.exe` or `.dmg` asset from the Release page.

assets/xfxcode-icon.png

616 KB
Loading

0 commit comments

Comments
 (0)