chore(docs): update CLAUDE.md and README.md for clarity and consistency

- Translated code style guidelines from Chinese to English for better accessibility.
- Revised Git commit conventions section for clarity and consistency in language.
- Updated README.md to reflect the correct GitHub repository and added a demo screenshot.
- Added new demo screenshot file to enhance visual representation of the project.
This commit is contained in:
Kayshen-X 2026-02-24 09:44:51 +08:00
parent 76f58ad239
commit 24ed397f0f
3 changed files with 23 additions and 24 deletions

View file

@ -227,15 +227,15 @@ Tailwind CSS v4 imported via `src/styles.css`. UI primitives from shadcn/ui (`sr
## Code Style
- 单个文件不要超过 800 行。超出时应拆分为更小的模块。
- 每个文件只导出一个组件,每个组件只承担单一职责。
- `.ts` `.tsx` 文件命名使用 kebab-case烤肉串风格例如 `canvas-store.ts`、`use-keyboard-shortcuts.ts`。
- UI 组件统一使用 shadcn/ui 设计令牌(`bg-card`、`text-foreground`、`border-border` 等),禁止使用硬编码的 `gray-*`、`blue-*` 等 Tailwind 颜色。
- 工具栏按钮激活状态直接用 `isActive` 条件 className`bg-primary text-primary-foreground`),不使用 Radix Toggle 的 `data-[state=on]:` 选择器(存在 twMerge 冲突)。
- Single files must not exceed 800 lines. Split into smaller modules when they grow beyond this limit.
- One component per file, each with a single responsibility.
- `.ts` and `.tsx` files use kebab-case naming, e.g. `canvas-store.ts`, `use-keyboard-shortcuts.ts`.
- UI components must use shadcn/ui design tokens (`bg-card`, `text-foreground`, `border-border`, etc.). No hardcoded Tailwind colors like `gray-*`, `blue-*`.
- Toolbar button active state uses `isActive` conditional className (`bg-primary text-primary-foreground`), not Radix Toggle's `data-[state=on]:` selector (has twMerge conflicts).
## Git Commit 规范
## Git Commit Convention
使用 [Conventional Commits](https://www.conventionalcommits.org/) 格式:
Use [Conventional Commits](https://www.conventionalcommits.org/) format:
```
<type>(<scope>): <subject>
@ -245,24 +245,24 @@ Tailwind CSS v4 imported via `src/styles.css`. UI primitives from shadcn/ui (`sr
### Type
- `feat`新功能
- `fix` — Bug 修复
- `refactor`重构(不改变行为)
- `perf`性能优化
- `style`代码格式(不影响逻辑)
- `docs`文档
- `test`测试
- `chore`构建/工具/依赖变更
- `feat`New feature
- `fix` — Bug fix
- `refactor`Refactoring (no behavior change)
- `perf`Performance optimization
- `style`Code formatting (no logic change)
- `docs`Documentation
- `test`Tests
- `chore`Build / tooling / dependency changes
### Scope
按模块划分:`editor`、`canvas`、`panels`、`history`、`ai`、`codegen`、`store`、`types`、`variables`。
By module: `editor`, `canvas`, `panels`, `history`, `ai`, `codegen`, `store`, `types`, `variables`.
### 规则
### Rules
- subject 用英文,小写开头,不加句号,祈使语气(如 `add`、`fix`、`remove`)。
- body 可选,解释 **why** 而非 what可用中英文。
- 一个 commit 只做一件事。不要把不相关的改动混在一起。
- Subject in English, lowercase start, no period, imperative mood (e.g. `add`, `fix`, `remove`).
- Body is optional; explain **why** not what.
- One commit per change. Do not mix unrelated changes in a single commit.
## License

View file

@ -1,6 +1,6 @@
<p align="center">
<img src="https://img.shields.io/github/license/nicepkg/openpencil" alt="License" />
<img src="https://img.shields.io/github/actions/workflow/status/nicepkg/openpencil/ci.yml?label=CI" alt="CI" />
<img src="https://img.shields.io/github/license/ZSeven-W/openpencil" alt="License" />
<img src="https://img.shields.io/github/actions/workflow/status/ZSeven-W/openpencil/ci.yml?branch=main&label=CI" alt="CI" />
<img src="https://img.shields.io/badge/runtime-Bun-f472b6" alt="Bun" />
<img src="https://img.shields.io/badge/platform-Web%20%7C%20macOS%20%7C%20Windows%20%7C%20Linux-blue" alt="Platform" />
</p>
@ -11,8 +11,7 @@ Open-source vector design tool with a **Design-as-Code** philosophy. An alternat
Design visually on an infinite canvas, generate code from designs, and let AI build entire screens from a single prompt — all in one tool that runs in your browser or as a native desktop app.
<!-- TODO: add screenshot -->
<!-- ![OpenPencil Editor](./docs/screenshot.png) -->
![OpenPencil Editor](./screenshot/demo.png)
## Highlights

BIN
screenshot/demo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 314 KiB