Skip to content
This repository was archived by the owner on Feb 16, 2025. It is now read-only.

Commit 891efc6

Browse files
committed
update readme
1 parent 15dc32f commit 891efc6

File tree

2 files changed

+43
-4
lines changed

2 files changed

+43
-4
lines changed

README.en.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Keyboard Monitor
2+
3+
> [中文](./README.md)
4+
5+
## What is this?
6+
7+
Keyboard Monitor (KM) is a simple software that helps you set up a service for mapping keyboard events. Use Tauri encapsulation to provide WebSocket services.
8+
9+
KM uses rustLang's system-level keyboard event support (rdev) to listen for user keyboard actions, and enables the WebSocket service in the multithreading provided by Tauri to provide communication channels. Upon a keyboard event response, the keyboard event is simultaneously broadcast to the WebSocket server with a fixed KM.
10+
11+
## Why?
12+
13+
Provides a basis for other programs to respond to keyboard events.
14+
15+
## How's it going?
16+
17+
The KM body installation package is only 2 to 3M, and the Memory usage is basically 5 to 7M when the GUI is not used (default). The calculation of Memory data does not include the necessary procedures for the system to run WebView2.
18+
19+
Overall, KM barely ranks among lightweight programs, both in terms of installation package size and running memory.
20+
21+
## License
22+
23+
This project is licensed under the [GUNv3](./LISENCE) license.

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,23 @@
1-
# Tauri + Vanilla TS
1+
# Keyboard Monitor
22

3-
This template should help get you started developing with Tauri in vanilla HTML, CSS and Typescript.
3+
> [English](./README.en.md)
44
5-
## Recommended IDE Setup
5+
## 是什么?
66

7-
- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
7+
Keyboard Monitor(以下简称KM)是一款帮助建立映射键盘事件服务的简洁软件。使用 Tauri 封装,提供 WebSocket 服务。
8+
9+
KM 使用了 rustLang 的系统级键盘事件支持(rdev)来监听用户的键盘操作,并在 Tauri 提供的多线程中启用 WebSocket 服务以提供通信频道。在键盘事件响应时,将同时向 KM 固定的 WebSocket 服务器广播该键盘事件。
10+
11+
## 为什么?
12+
13+
为其他程序提供键盘事件的响应基础。
14+
15+
## 怎么样?
16+
17+
KM 本体安装包仅 2 ~ 3M,经测试在不使用图形界面(默认)时的内存(Memory)用量基本在 5 ~ 7M。其中 Memory 方面的数据测算不包含系统运行 WebView2 的必要程序。
18+
19+
总体来说,KM 勉强可以排在轻量程序中,无论是在安装包大小还是在运行内存上。
20+
21+
## 许可
22+
23+
本项目使用 [GUNv3](./LISENCE) 许可。

0 commit comments

Comments
 (0)