Skip to content

Commit 987e871

Browse files
committed
add README
1 parent 636d6c0 commit 987e871

2 files changed

Lines changed: 20 additions & 0 deletions

File tree

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# TerminalVirtualKeyboard
2+
3+
A high-performance, real-time, customizable terminal virtual keyboard written in Rust, powered by RataTUI
4+
5+
## Usage
6+
7+
```
8+
tvk <tvkl_file>
9+
```
10+
11+
## Snapshot
12+
13+
![snapshot](./snapshot.png)
14+
15+
## TVKL
16+
17+
The tvkl, Terminal Virtual Keyboard Layout, is a format used to represent your keyboard layout which makes customization easlier and more ergonomic <br>
18+
19+
You can check the tvkl grammar here: [tvkl](./tvkl/grammar/tvkl.gram) <br>
20+
There are some examples here: [layouts](./layouts) <br>

snapshot.png

63.9 KB
Loading

0 commit comments

Comments
 (0)