Skip to content

Commit 57e2366

Browse files
committed
📝 README
1 parent 0242c0d commit 57e2366

File tree

2 files changed

+169
-0
lines changed

2 files changed

+169
-0
lines changed

README-EN.md

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Awesome Hands <img src="https://img.shields.io/badge/-Windows-gray?style=flat-square&logo=windows&logoColor=white"> <img src="https://img.shields.io/badge/-macOS-black?style=flat-square&logo=apple&logoColor=white">
2+
3+
[中文文档](./README.md) | README in English
4+
5+
## 🔥 Feature
6+
7+
### ✨ Support Various Gesture Recognitions
8+
9+
- Open Palm / Close Fist
10+
- Index Pointing Up / Victory
11+
- Thumb Up / Thumb Down
12+
13+
### ✨ Support Various Operational Controls
14+
15+
- Bind to any software
16+
- Bind to any shortcut key
17+
- Simulate mouse actions ( scroll / cursor / click )
18+
- Simulate specific behaviors ( adjust volume / switch songs )
19+
20+
## 🧙🏻 Quick Start
21+
22+
### 🔮 Ready to Use
23+
Download the packaged installer directly from [release](https://github.com/RylanBot/awesome-hands-control/releases).
24+
25+
### 🔮 For Development
26+
If you are familiar with Web frontend technologies and are interested in the source code, you can run this program using the following commands.
27+
28+
```sh
29+
npm install
30+
npm run dev
31+
```
32+
33+
## 🌷 Preview
34+
> 🔊 **The bound software name corresponds to the process name in the task manager.**
35+
> All operating systems support uploading local images, and Windows supports automatic icon extraction after selecting a .exe file.
36+
37+
![dashboard](https://s2.loli.net/2023/12/09/X1Pl9NdOKGDheFT.png)
38+
![global](https://s2.loli.net/2023/12/10/mHlXoWQ2vrUkBqK.png)
39+
![setting](https://s2.loli.net/2023/12/10/TDwQo7t4Eh6RkzN.png)
40+
![camera](https://s2.loli.net/2023/12/08/o1LgSDsB8JVwhXK.png)
41+
42+
## ⚙️ Tech Stack
43+
44+
### 💻 Framework
45+
46+
- [![Vite](https://img.shields.io/badge/-Vite-blueviolet?logo=vite&logoColor=white&style=flat-square)](https://vitejs.dev/)
47+
- [![React](https://img.shields.io/badge/-React-blue?logo=react&logoColor=white&style=flat-square)](https://react.dev/)
48+
- [![Electron](https://img.shields.io/badge/-Electron-dodgerblue?logo=electron&logoColor=white&style=flat-square)](https://www.electronjs.org/)
49+
- [![TypeScript](https://img.shields.io/badge/-TypeScript-goldenrod?logo=TypeScript&logoColor=white&style=flat-square)](https://www.electronjs.org/)
50+
- [![Tailwind CSS](https://img.shields.io/badge/-Tailwind%20CSS-teal?logo=tailwind-css&logoColor=white&style=flat-square)](https://tailwindcss.com/)
51+
52+
### 💻 Core Library
53+
54+
- [MediaPipe](https://developers.google.com/mediapipe)
55+
- [active-win](https://github.com/sindresorhus/active-win)
56+
- [Robotjs](http://robotjs.io/)
57+
58+
## 🧸 Acknowledgements
59+
60+
Thanks to my friends who provided test environments and valuable advice.
61+
62+
<table>
63+
<tr>
64+
<td align="center">
65+
<a href="https://github.com/ligeaaa" style="display:inline-block;width:80px">
66+
<img src="https://github.com/ligeaaa.png" width="64px;" alt="ligeaaa"/><br/>
67+
<sub><b>ligeaaa</b></sub>
68+
</a>
69+
</td>
70+
<td align="center">
71+
<a href="https://github.com/quecheny" style="display:inline-block;width:80px">
72+
<img src="https://github.com/quecheny.png" width="64px;" alt="quecheny"/><br/>
73+
<sub><b>quecheny</b></sub>
74+
</a>
75+
</td>
76+
<td align="center">
77+
<a href="https://github.com/LoganZeng" style="display:inline-block;width:80px">
78+
<img src="https://github.com/LoganZeng.png" width="64px;" alt="LoganZeng"/><br/>
79+
<sub><b>LoganZeng</b></sub>
80+
</a>
81+
</td>
82+
</tr>
83+
</table>

README.md

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# Awesome Hands <img src="https://img.shields.io/badge/-Windows-gray?style=flat-square&logo=windows&logoColor=white"> <img src="https://img.shields.io/badge/-macOS-black?style=flat-square&logo=apple&logoColor=white">
2+
3+
中文文档 | [README in English](./README-EN.md)
4+
5+
## 🔥 功能介绍
6+
7+
### ✨ 支持多种手势识别
8+
9+
- 打开手掌 / 握拳
10+
- 竖起食指 / 比耶
11+
- 大拇指向上 / 向下
12+
13+
### ✨ 支持多种操作控制
14+
15+
- 绑定任意软件
16+
- 绑定任意快捷键
17+
- 模拟鼠标动作( 滚轮 / 光标 / 点击 )
18+
- 模拟特定行为( 调节音量 / 切换歌曲 )
19+
20+
## 🧙🏻 快速上手
21+
22+
### 🔮 开箱即用
23+
24+
直接在 [release](https://github.com/RylanBot/awesome-hands-control/releases) 中下载已经打包好的安装包
25+
26+
### 🔮 二次开发
27+
28+
如果你熟悉 Web 前端技术且对源码感兴趣,可以根据以下命令,在本地启动这个程序
29+
30+
```sh
31+
npm install
32+
npm run dev
33+
```
34+
35+
## 🌷 效果预览
36+
37+
> 🔊 **绑定的软件名对应任务管理器中的进程名**
38+
> 所有操作系统支持上传本地图片,Windows 支持选择 .exe 文件后自动提取图标。
39+
40+
![dashboard](https://s2.loli.net/2023/12/09/X1Pl9NdOKGDheFT.png)
41+
![global](https://s2.loli.net/2023/12/10/mHlXoWQ2vrUkBqK.png)
42+
![setting](https://s2.loli.net/2023/12/10/TDwQo7t4Eh6RkzN.png)
43+
![camera](https://s2.loli.net/2023/12/08/o1LgSDsB8JVwhXK.png)
44+
45+
## ⚙️ 技术栈
46+
47+
### 💻 框架
48+
49+
- [![Vite](https://img.shields.io/badge/-Vite-blueviolet?logo=vite&logoColor=white&style=flat-square)](https://vitejs.dev/)
50+
- [![React](https://img.shields.io/badge/-React-blue?logo=react&logoColor=white&style=flat-square)](https://react.dev/)
51+
- [![Electron](https://img.shields.io/badge/-Electron-dodgerblue?logo=electron&logoColor=white&style=flat-square)](https://www.electronjs.org/)
52+
- [![TypeScript](https://img.shields.io/badge/-TypeScript-goldenrod?logo=TypeScript&logoColor=white&style=flat-square)](https://www.electronjs.org/)
53+
- [![Tailwind CSS](https://img.shields.io/badge/-Tailwind%20CSS-teal?logo=tailwind-css&logoColor=white&style=flat-square)](https://tailwindcss.com/)
54+
55+
### 💻 核心库
56+
57+
- [MediaPipe](https://developers.google.com/mediapipe)
58+
- [active-win](https://github.com/sindresorhus/active-win)
59+
- [Robotjs](http://robotjs.io/)
60+
61+
## 🧸 致谢
62+
63+
感谢朋友们提供的测试环境和宝贵意见
64+
65+
<table>
66+
<tr>
67+
<td align="center">
68+
<a href="https://github.com/ligeaaa" style="display:inline-block;width:80px">
69+
<img src="https://github.com/ligeaaa.png" width="64px;" alt="ligeaaa"/><br/>
70+
<sub><b>ligeaaa</b></sub>
71+
</a>
72+
</td>
73+
<td align="center">
74+
<a href="https://github.com/quecheny" style="display:inline-block;width:80px">
75+
<img src="https://github.com/quecheny.png" width="64px;" alt="quecheny"/><br/>
76+
<sub><b>quecheny</b></sub>
77+
</a>
78+
</td>
79+
<td align="center">
80+
<a href="https://github.com/LoganZeng" style="display:inline-block;width:80px">
81+
<img src="https://github.com/LoganZeng.png" width="64px;" alt="LoganZeng"/><br/>
82+
<sub><b>LoganZeng</b></sub>
83+
</a>
84+
</td>
85+
</tr>
86+
</table>

0 commit comments

Comments
 (0)