Skip to content

Commit 6cbd13a

Browse files
docs: update
1 parent c97a00f commit 6cbd13a

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
> any!\
44
> 此项目仍在开发阶段,如果遇到问题请发送 Issue
55
6+
[中文](./README_zh.md)
7+
68
<div align=center>
79
<img src=./resources/icon.svg />
810
<h1>Breeze Shell</h1>

README_zh.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<div align=center>
2+
<img src=./resources/icon.svg />
3+
<h1>Breeze Shell</h1>
4+
<h5>为 Windows 重新带来流畅与精致体验</h5>
5+
<div>
6+
<img widtb=500 src=./resources/preview1.webp />
7+
</div>
8+
</div>
9+
10+
Breeze 是专为 Windows 10/11 设计的现代化**次世代右键菜单解决方案**
11+
12+
## 丝滑流畅
13+
14+
Breeze 以交互动画为核心设计理念。
15+
16+
<img src=https://github.com/user-attachments/assets/304fdd08-ef67-4cdb-94cc-83b47d41eb36 height=300 />
17+
18+
## 无限扩展
19+
20+
通过嵌入式 JavaScript 脚本 API,您可以用寥寥数行代码为右键菜单增添全新功能。
21+
22+
```javascript
23+
shell.menu_controller.add_menu_listener((e) => {
24+
e.menu.add_menu_item_after({
25+
type: "button",
26+
name: "Shuffle Buttons",
27+
action: () => {
28+
for (const item of menus) {
29+
item.set_position(Math.floor(menus.length * Math.random()));
30+
}
31+
},
32+
}, 0);
33+
});
34+
```
35+
36+
[查看完整 API 文档 →](./src/shell/script/binding_types.d.ts)
37+
38+
## 轻量高速
39+
40+
Breeze 基于自研 breeze-ui 框架实现,这是一个跨平台、简洁优雅、动画友好的现代 C++ UI 库,支持 NanoVG 和 ThorVG 双渲染后端。这使得 Breeze 能在约 2MB 的体积下实现精致的视觉体验。
41+
42+
# 立即体验
43+
44+
`inject.exe``shell.dll` 置于同一目录,运行 `inject.exe` 后,您的右键菜单将被无缝替换。
45+
46+
# 构建指南
47+
48+
本项目使用 xmake 构建系统。请先安装 xmake,在项目根目录执行 `xmake` 命令并按提示操作。支持 clang-cl 和 MSVC 2019+ 编译器。
49+
50+
# 开发指南
51+
52+
首次构建成功后,可使用 VSCode 打开项目进行开发。建议安装 clangd 插件以获得完整的代码智能提示。

0 commit comments

Comments
 (0)