mirror of
https://github.com/rubickCenter/rubick
synced 2025-07-16 20:27:29 +08:00
docs: 更新英文文档
This commit is contained in:
muwoo
parent
1c893542b9
commit
2df00360e4
57
README.md
57
README.md
@ -1,3 +1,5 @@
|
||||
English | [简体中文](https://github.com/clouDr-f2e/rubick/blob/master/README.zh-CN.md)
|
||||
|
||||
<div align= "center">
|
||||
<img align="center" width=200 src="https://user-images.githubusercontent.com/21073039/128333805-73e086f0-5523-46a3-a096-cba80b904c46.png" />
|
||||
</div>
|
||||
@ -25,7 +27,7 @@
|
||||
</div>
|
||||
|
||||
|
||||
基于 electron 的开源工具箱，自由集成丰富插件，打造极致的桌面端效能工具。Rubick(拉比克) 是 dota 里面的英雄之一，其核心技能是插件化使用其他英雄的技能，用完即走。非常符合本工具的设计理念，所以取名 Rubick。
|
||||
Based on electron open source toolbox, free integration of rich plug-ins, to create the ultimate desktop efficiency tool。Rubick is one of the heroes of Dota ，The core skill is the ability to use other heroes as plug-ins，Finished the walk 。Very consistent with the design concept of this tool，So named Rubick。
|
||||
|
||||
## 安装包
|
||||
* [Rubick Mac OS](https://github.com/clouDr-f2e/rubick/releases)
|
||||
@ -33,64 +35,61 @@
|
||||
* [Rubick Linux](https://github.com/clouDr-f2e/rubick/releases)
|
||||
|
||||
## 支持能力
|
||||
- [x] 支持远程下载安装插件，支持插件开发者模式
|
||||
- [x] 支持插件分离
|
||||
- [x] 支持系统命令取色、截屏、帮助
|
||||
- [x] 支持超级面板，长按右击呼出
|
||||
- [x] 支持全局快捷键设置
|
||||
- [x] 支持搜索本地已安装 app 或 偏好设置
|
||||
- [x] macos touchBar 唤起插件
|
||||
- [x] 支持 Windows(目前是 mac 的 alpha 版本，功能尚不全，正在迁移中)
|
||||
- [x] 支持 Linux
|
||||
- [x] Support remote download plug-in installation, support plug-in developer mode
|
||||
- [x] Support plug-in separation
|
||||
- [x] Support system command color picker、screen capture、 help
|
||||
- [x] Support super panel, long press and right click to make a call
|
||||
- [x] Support global shortcut key Settings
|
||||
- [x] You can search for locally installed APPS or preferences
|
||||
- [x] Support macos touchBar arouse the plug-in
|
||||
- [x] Support Windows
|
||||
- [x] Support Linux
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 使用文档
|
||||
## Docs
|
||||
|
||||
[Rubick Docs](https://cloudr-f2e.github.io/rubick/)
|
||||
|
||||
|
||||
## 使用问题
|
||||
1. 依赖于 `robotjs` dev 环境运行请在 `install` 后执行 `npm run rebuild`
|
||||
2. windows 版本目前有了一个最基础的可用版，代码在 [feat-win](https://github.com/clouDr-f2e/rubick/tree/feat-win) 分支。完整版正在开发中，敬请期待
|
||||
3. linux 开发分支 cross-platform 的 iohook 开发模式下可能需要手动下载并放入node_modules, 将在未来修复
|
||||
## Tips
|
||||
依赖于 `robotjs` dev 环境运行请在 `install` 后执行 `npm run rebuild`
|
||||
|
||||
## 目前支持能力
|
||||
## Current support capability
|
||||
|
||||
### touchBar 唤起插件
|
||||
macOS 支持 touchbar 快速唤起插件
|
||||
### touchBar
|
||||
macOS support touchbar Quick recall plug-in
|
||||
|
||||
|
||||
|
||||
|
||||
### 超级面板
|
||||
长按鼠标右键，即可呼起超级面板，可以根据当前鼠标选择内容，匹配对应插件能力。比如当前选择图片后长按右击，则会呼起上传图床插件：
|
||||
### Super Panel
|
||||
Long press the right mouse button to call up the super panel. You can select content according to the current mouse and match the ability of the plug-in. For example, after selecting a picture, long press and right click to call up the plug-in to upload the picture bed.
|
||||
|
||||
|
||||
|
||||
### 模板
|
||||
模板即是一个内置 UI 样式的功能插件。
|
||||
### Template
|
||||
A template is a built-in UI-style function plug-in.
|
||||
|
||||
<img src=https://p1-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/0b113ad547974699b9c73c28bc09b9b1~tplv-k3u1fbpfcp-watermark.image width=500 />
|
||||
|
||||
### 系统命令
|
||||
#### 取色
|
||||
基于 `robot.js` 以及 `iohook` 实现。未使用 C++ 扩展。
|
||||
### System Command
|
||||
#### Color picker
|
||||
Based on `robot.js` and `iohook`。
|
||||
|
||||
|
||||
|
||||
#### 截屏
|
||||
#### Screen capture
|
||||
|
||||
<img src=https://p6-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/18023dab52e1420c9e87362cefddb2a1~tplv-k3u1fbpfcp-watermark.image width=500 />
|
||||
|
||||
|
||||
#### 全局快捷键
|
||||
#### Global Hotkeys
|
||||
|
||||
<img src=https://p9-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/62cc424eacac4c9eb178f0e055e87d9a~tplv-k3u1fbpfcp-watermark.image width=500 />
|
||||
|
||||
### 最后
|
||||
### At last
|
||||
对本项目有兴趣或者想要交流学习的同学可以扫码加下面的微信，备注 rubick，帮助我们更好的成长：
|
||||
|
||||
|
||||
|
||||
102
README.zh-CN.md
Normal file
102
README.zh-CN.md
Normal file
@ -0,0 +1,102 @@
|
||||
[English](https://github.com/clouDr-f2e/rubick/blob/master/README.md) | 简体中文
|
||||
|
||||
|
||||
<div align= "center">
|
||||
<img align="center" width=200 src="https://user-images.githubusercontent.com/21073039/128333805-73e086f0-5523-46a3-a096-cba80b904c46.png" />
|
||||
</div>
|
||||
|
||||
|
||||
<div align= "center">
|
||||
<h1>Rubick</h1>
|
||||
|
||||
<img alt="release" src="https://img.shields.io/github/downloads/clouDr-f2e/rubick/total" />
|
||||
<a href="https://github.com/clouDr-f2e/rubick/releases">
|
||||
<img alt="release" src="https://img.shields.io/github/package-json/v/clouDr-f2e/rubick" />
|
||||
</a>
|
||||
<a href="https://github.com/clouDr-f2e/rubick/actions">
|
||||
<img alt=building src=https://img.shields.io/github/workflow/status/clouDr-f2e/rubick/Build>
|
||||
</a>
|
||||
<a href="https://github.com/clouDr-f2e/rubick/blob/master/LICENSE">
|
||||
<img alt="npm" src="https://img.shields.io/github/license/clouDr-f2e/rubick" />
|
||||
</a>
|
||||
<a href="https://github.com/clouDr-f2e/rubick/stargazers">
|
||||
<img alt="star" src="https://img.shields.io/github/stars/clouDr-f2e/rubick?style=social">
|
||||
</a>
|
||||
<a href="https://gitee.com/monkeyWang/rubick">
|
||||
<img alt="码云" src="https://img.shields.io/badge/Gitee--yellow.svg?style=social&logo=data:image/svg+xml;base64,PHN2ZyB0PSIxNTc0ODM3MTM4ODM3IiBjbGFzcz0iaWNvbiIgdmlld0JveD0iMCAwIDEwMjQgMTAyNCIgdmVyc2lvbj0iMS4xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHAtaWQ9IjE3NzAiICAgICB3aWR0aD0iMTYiIGhlaWdodD0iMTYiPiAgICA8cGF0aCBkPSJNODkxIDQyOC44SDQ2NS44Yy0yMC40IDAtMzcgMTYuNS0zNyAzN3Y5Mi40YzAgMjAuNCAxNi41IDM3IDM3IDM3aDI1OC45YzIwLjQgMCAzNyAxNi42IDM3IDM3djE4LjRjMCA2MS4zLTQ5LjcgMTEwLjktMTEwLjkgMTEwLjlIMjk5LjRjLTIwLjQgMC0zNy0xNi42LTM3LTM3VjM3My4yYzAtNjEuMyA0OS43LTExMC45IDExMC45LTExMC45aDUxNy42YzIwLjQgMCAzNy0xNi41IDM3LTM3bDAuMS05Mi4zYzAtMjAuNC0xNi41LTM3LTM3LTM3SDM3My4zQzIyMC4yIDk2IDk2IDIyMC4yIDk2IDM3My4zVjg5MWMwIDIwLjQgMTYuNiAzNyAzNyAzN2g1NDUuNEM4MTYuMiA5MjggOTI4IDgxNi4zIDkyOCA2NzguNFY0NjUuOGMwLTIwLjQtMTYuNi0zNy0zNy0zN3oiICAgICAgICAgIGZpbGw9IiNkODFlMDYiIHAtaWQ9IjE3NzEiPjwvcGF0aD48L3N2Zz4="/>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
|
||||
基于 electron 的开源工具箱，自由集成丰富插件，打造极致的桌面端效能工具。Rubick(拉比克) 是 dota 里面的英雄之一，其核心技能是插件化使用其他英雄的技能，用完即走。非常符合本工具的设计理念，所以取名 Rubick。
|
||||
|
||||
## 安装包
|
||||
* [Rubick Mac OS](https://github.com/clouDr-f2e/rubick/releases)
|
||||
* [Rubick Windows](https://github.com/clouDr-f2e/rubick/releases)
|
||||
* [Rubick Linux](https://github.com/clouDr-f2e/rubick/releases)
|
||||
|
||||
## 支持能力
|
||||
- [x] 支持远程下载安装插件，支持插件开发者模式
|
||||
- [x] 支持插件分离
|
||||
- [x] 支持系统命令取色、截屏、帮助
|
||||
- [x] 支持超级面板，长按右击呼出
|
||||
- [x] 支持全局快捷键设置
|
||||
- [x] 支持搜索本地已安装 app 或 偏好设置
|
||||
- [x] macos touchBar 唤起插件
|
||||
- [x] 支持 Windows
|
||||
- [x] 支持 Linux
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 使用文档
|
||||
|
||||
[Rubick Docs](https://cloudr-f2e.github.io/rubick/)
|
||||
|
||||
|
||||
## 使用问题
|
||||
依赖于 `robotjs` dev 环境运行请在 `install` 后执行 `npm run rebuild`
|
||||
|
||||
## 目前支持能力
|
||||
|
||||
### touchBar 唤起插件
|
||||
macOS 支持 touchbar 快速唤起插件
|
||||
|
||||
|
||||
|
||||
|
||||
### 超级面板
|
||||
长按鼠标右键，即可呼起超级面板，可以根据当前鼠标选择内容，匹配对应插件能力。比如当前选择图片后长按右击，则会呼起上传图床插件：
|
||||
|
||||
|
||||
|
||||
### 模板
|
||||
模板即是一个内置 UI 样式的功能插件。
|
||||
|
||||
<img src=https://p1-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/0b113ad547974699b9c73c28bc09b9b1~tplv-k3u1fbpfcp-watermark.image width=500 />
|
||||
|
||||
### 系统命令
|
||||
#### 取色
|
||||
基于 `robot.js` 以及 `iohook` 实现。未使用 C++ 扩展。
|
||||
|
||||
|
||||
|
||||
#### 截屏
|
||||
|
||||
<img src=https://p6-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/18023dab52e1420c9e87362cefddb2a1~tplv-k3u1fbpfcp-watermark.image width=500 />
|
||||
|
||||
|
||||
#### 全局快捷键
|
||||
|
||||
<img src=https://p9-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/62cc424eacac4c9eb178f0e055e87d9a~tplv-k3u1fbpfcp-watermark.image width=500 />
|
||||
|
||||
### 最后
|
||||
对本项目有兴趣或者想要交流学习的同学可以扫码加下面的微信，备注 rubick，帮助我们更好的成长：
|
||||
|
||||
|
||||
|
||||
|
||||
## License
|
||||
This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/clouDr-f2e/rubick/blob/master/LICENSE) file for details.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user