You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+41-20Lines changed: 41 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,22 @@
1
1

2
2
3
-
Keyviz is a free and open-source software to visualise your keystrokes and mouse actions in real time! Let your audience know what handy shortcuts/keys you're pressing during screencasts, presentations, collaborations, or whenever you need it.
3
+
Keyviz is a free and open-source software to visualise your keystrokes and mouse actions in real time! Let your audience
4
+
know what handy shortcuts/keys you're pressing during screencasts, presentations, collaborations, or whenever you need
5
+
it.
4
6
5
7
**English** | [简体中文](./README_zh_CN.md)
6
8
7
9
# ⌨️ Keystrokes & 🖱️ Mouse Actions
8
10
9
-
Now you can visualize mouse actions! Not only mouse clicks, you can also visualize mouse actions along with keystrokes like <kbd>Cmd</kbd> + <kbd>Click</kbd>, <kbd>Alt</kbd> + <kbd>Drag</kbd>, etc.
11
+
Now you can visualize mouse actions! Not only mouse clicks, you can also visualize mouse actions along with keystrokes
12
+
like <kbd>Cmd</kbd> + <kbd>Click</kbd>, <kbd>Alt</kbd> + <kbd>Drag</kbd>, etc.
10
13
11
14

12
15
13
16
# 🎨 Stylize
14
17
15
-
Don't restrain yourself to just black & white! You can customize every aspect of the visualization. The visualisation's style, size, colour (modifier and regular keys), border, icon, etc.
18
+
Don't restrain yourself to just black & white! You can customize every aspect of the visualization. The visualisation's
19
+
style, size, colour (modifier and regular keys), border, icon, etc.
16
20
17
21

18
22
@@ -27,24 +31,29 @@ Powerful and easy-to-use configuration options.
27
31
28
32
# 📥 Installation
29
33
30
-
You can download the latest version of keyviz from the [Github Releases](https://github.com/mulaRahul/keyviz/releases) page. For the installer, unzip the downloaded file, run the installer and follow the familiar steps to install keyviz.
34
+
You can download the latest version of keyviz from the [Github Releases](https://github.com/algosul/keyviz/releases)
35
+
page. For the installer, unzip the downloaded file, run the installer and follow the familiar steps to install keyviz.
31
36
32
37
Below are the platform specifics options and requirements -
33
38
34
39
<details>
35
40
36
41
<summary>🪟 Windows</summary>
37
42
38
-
### 👜 Microsoft Store
39
-
You can download keyviz directly from the [microsoft store](https://apps.microsoft.com/detail/Keyviz/9phzpj643p7l?mode=direct).
43
+
### 👜 Microsoft Store
44
+
45
+
You can download keyviz directly from
46
+
the [microsoft store](https://apps.microsoft.com/detail/Keyviz/9phzpj643p7l?mode=direct).
47
+
48
+
### 🥄 Scoop
40
49
41
-
### 🥄 Scoop
42
50
```bash
43
51
scoop bucket add extras # first, add the bucket
44
52
scoop install keyviz
45
53
```
46
54
47
-
### 📦 Winget
55
+
### 📦 Winget
56
+
48
57
```bash
49
58
winget install mulaRahul.Keyviz
50
59
```
@@ -54,7 +63,9 @@ Below are the platform specifics options and requirements -
If you're getting a `.dll` missing error after installing the application, you're missing the required Visual C++ redistributables. You can get the same from here [VSC++ Redist](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170).
66
+
If you're getting a `.dll` missing error after installing the application, you're missing the required Visual C++
67
+
redistributables. You can get the same from
68
+
here [VSC++ Redist](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170).
58
69
59
70
</details>
60
71
@@ -66,10 +77,11 @@ Below are the platform specifics options and requirements -
66
77
67
78
<summary>🍎 MacOS</summary>
68
79
69
-
### 🔒 Permission
70
-
71
-
Keyviz requires **Input Monitoring** and **Accessibility** permissions. Enable the same in settings -
72
-
</br>
80
+
### 🔒 Permission
81
+
82
+
Keyviz requires **Input Monitoring** and **Accessibility** permissions. Enable the same in settings -
@@ -112,7 +131,8 @@ Below are the platform specifics options and requirements -
112
131
113
132
# 🛠️ Build Instructions
114
133
115
-
You can always further develop/build the project by yourself. First of all ensure that you've setup Flutter on your system. If not follow this [guide](https://docs.flutter.dev/get-started/install).
134
+
You can always further develop/build the project by yourself. First of all ensure that you've setup Flutter on your
135
+
system. If not follow this [guide](https://docs.flutter.dev/get-started/install).
116
136
117
137
After setting up flutter, clone the repository if you have `git` installed or download the zip and unpack the same.
118
138
@@ -132,4 +152,5 @@ flutter build windows
132
152
133
153
# 💖 Support
134
154
135
-
As keyviz is freeware, the only way I can earn is through your generous donations. It helps free my time and work more on keyviz.
155
+
As keyviz is freeware, the only way I can earn is through your generous donations. It helps free my time and work more
0 commit comments