Skip to content

Commit d94ca85

Browse files
committed
docs: banner hero + architecture diagram in 中文 README
1 parent 9749be7 commit d94ca85

1 file changed

Lines changed: 17 additions & 3 deletions

File tree

README_CN.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
1-
# 码上懂 CodeABC
1+
<div align="center">
22

3-
**不用学编程,也能读懂代码。** 一款面向零编程基础用户的 AI 代码阅读工具。
3+
<img src="docs/banner.png" alt="CodeABC — 不用学编程也能读懂代码" width="100%">
4+
5+
[![Python](https://img.shields.io/badge/python-3.10+-blue)](https://python.org)
6+
[![License: MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE)
7+
[![CI](https://github.com/he-yufeng/CodeABC/actions/workflows/ci.yml/badge.svg)](https://github.com/he-yufeng/CodeABC/actions)
8+
9+
[**快速开始**](#快速开始) · [**工作原理**](#工作原理) · [**功能**](#功能) · [English](README.md)
10+
11+
</div>
412

5-
[English README](README.md)
13+
**不用学编程,也能读懂代码。** 一款面向零编程基础用户的 AI 代码阅读工具。
614

715
Cursor/VS Code 是给程序员用的瑞士军刀,码上懂是给普通人用的放大镜 -- 让你像读文章一样读代码,像批注文章一样理解代码。
816

@@ -20,6 +28,12 @@ Cursor/VS Code 是给程序员用的瑞士军刀,码上懂是给普通人用
2028

2129
**AI 已经能完美解释代码了,缺的是一款把这个能力包装成好用体验的产品。**
2230

31+
## 工作原理
32+
33+
![CodeABC 架构](docs/architecture.png)
34+
35+
拖入一个文件夹或粘贴 GitHub 链接。码上懂扫描项目(跳过构建产物、缓存和疑似密钥的文件),先生成**无需 API key 的即时确定性图谱**——阅读路线图、核心模块排序、测试覆盖视图等,再在上面叠加 AI 解释:大白话项目说明书、逐行悬停批注、问答框。一切都在双语浏览器界面里呈现。
36+
2337
## 功能
2438

2539
### 项目说明书

0 commit comments

Comments
 (0)