Skip to content

Commit 660f3de

Browse files
committed
Update README.md
1 parent 1218da2 commit 660f3de

File tree

2 files changed

+47
-25
lines changed

2 files changed

+47
-25
lines changed

README.md

Lines changed: 41 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
![keyviz-2.0](previews/banner.svg)
22

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.
46

57
**English** | [简体中文](./README_zh_CN.md)
68

79
# ⌨️ Keystrokes & 🖱️ Mouse Actions
810

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.
1013

1114
![key-visualizer](previews/visualizer-bar.svg)
1215

1316
# 🎨 Stylize
1417

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.
1620

1721
![settings-window](previews/settings.svg)
1822

@@ -27,24 +31,29 @@ Powerful and easy-to-use configuration options.
2731

2832
# 📥 Installation
2933

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.
3136

3237
Below are the platform specifics options and requirements -
3338

3439
<details>
3540

3641
<summary>🪟 Windows</summary>
3742

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
4049

41-
### 🥄 Scoop
4250
```bash
4351
scoop bucket add extras # first, add the bucket
4452
scoop install keyviz
4553
```
4654

47-
### 📦 Winget
55+
### 📦 Winget
56+
4857
```bash
4958
winget install mulaRahul.Keyviz
5059
```
@@ -54,7 +63,9 @@ Below are the platform specifics options and requirements -
5463
<details>
5564
<summary><code>*.dll</code> missing error?</summary>
5665

57-
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).
5869

5970
</details>
6071

@@ -66,10 +77,11 @@ Below are the platform specifics options and requirements -
6677

6778
<summary>🍎 MacOS</summary>
6879

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 -
83+
</br>
84+
7385
```
7486
Settings > Privacy & Security > Input Monitoring/Accessibility
7587
```
@@ -84,21 +96,28 @@ Below are the platform specifics options and requirements -
8496

8597
<summary>🐧 Linux</summary>
8698

87-
### v2.x.x Requirements
99+
### v2.x.x Requirements
100+
88101
```bash
89102
sudo apt-get install libayatana-appindicator3-dev
90103
```
91-
or
104+
105+
or
106+
92107
```bash
93108
sudo apt-get install appindicator3-0.1 libappindicator3-dev
94109
```
95110

96-
### Install debian package
111+
### Install debian package
112+
97113
```bash
98114
sudo apt install ./keyviz.deb
99115
```
100-
or
101-
### Install RPM
116+
117+
or
118+
119+
### Install RPM
120+
102121
```bash
103122
sudo rpm -i app.rpm
104123
```
@@ -112,7 +131,8 @@ Below are the platform specifics options and requirements -
112131

113132
# 🛠️ Build Instructions
114133

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).
116136

117137
After setting up flutter, clone the repository if you have `git` installed or download the zip and unpack the same.
118138

@@ -132,4 +152,5 @@ flutter build windows
132152

133153
# 💖 Support
134154

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
156+
on keyviz.

README_zh_CN.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ Keyviz也可以显示鼠标、键盘+鼠标的操作,比如 <kbd>Cmd</kbd> + <
2727

2828
# 📥 安装
2929

30-
[Github Releases](https://github.com/mulaRahul/keyviz/releases) 下载最新版,根据操作系统安装/解压即用,或者通过下面的包管理器安装
30+
[Github Releases](https://github.com/mulaRahul/algosul/releases) 下载最新版,根据操作系统安装/解压即用,或者通过下面的包管理器安装
3131

3232
<details>
3333
<summary>🥄 Scoop</summary>
34-
34+
3535
```bash
3636
scoop bucket add extras # first, add the bucket
3737
scoop install keyviz
@@ -41,7 +41,7 @@ Keyviz也可以显示鼠标、键盘+鼠标的操作,比如 <kbd>Cmd</kbd> + <
4141

4242
<details>
4343
<summary>🪟 Winget</summary>
44-
44+
4545
```bash
4646
winget install mulaRahul.Keyviz
4747
```
@@ -52,8 +52,9 @@ Keyviz也可以显示鼠标、键盘+鼠标的操作,比如 <kbd>Cmd</kbd> + <
5252

5353
<details>
5454
<summary>提示缺少<code>*.dll</code>?</summary>
55-
56-
如果运行程序弹出了缺少`.dll`文件的错误,大概率是环境缺少了VC++运行库,你可以在[**这里**](https://learn.microsoft.com/zh-cn/cpp/windows/latest-supported-vc-redist?view=msvc-170)下载安装
55+
56+
如果运行程序弹出了缺少`.dll`文件的错误,大概率是环境缺少了VC++运行库,你可以在[**这里
57+
**](https://learn.microsoft.com/zh-cn/cpp/windows/latest-supported-vc-redist?view=msvc-170)下载安装
5758

5859
</details>
5960

0 commit comments

Comments
 (0)