Skip to content

Commit 795f056

Browse files
committed
2 parents 041508c + 5a1c4c5 commit 795f056

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
2121
<br>
2222

23-
![image](https://github.com/BooleanCube/keylab.nvim/blob/f794722563d454a756147aaad94a9034dfd42272/doc/usage.gif)
23+
![image](https://github.com/BooleanCube/keylab.nvim/blob/main/doc/usage.gif)
2424

2525
<br>
2626

@@ -46,6 +46,24 @@ To use keylab effectively, I would suggest 3-5 practice sessions everyday before
4646
My biggest improvements were: being able to locate and press weird keys (like ">(#{") without having to look at the keyboard. I also saw a decent increase in accuracy which means I don't mess up on weird keys that often anymore.
4747
</p>
4848

49+
## Stages
50+
51+
### Typing
52+
<p>
53+
To start a session, you can use <code>:KeylabStart</code> or use the preferred keybinding you used in your nvim configuration setup. <br>
54+
This will open up a script window (script excerpt) and a blank window (typing playground). The goal is to copy the script into the blank window as fast as possible. Your typing speed will be measured and recorded for you.
55+
</p>
56+
57+
### Statistics
58+
<p>
59+
After you finish copying the excerpted script into the <code>typing playground window</code>, the windows will close an open a separate individual window with the measured statistics of your performance of the current session. <br>
60+
<i>These statistics will be measured for quality of usage and the measured data can be reset very easily using <code>:KeylabClearPerf</code></i>
61+
</p>
62+
<p>
63+
Press <code>q</code> to quit the current keylab session and <code>CR</code> to start a new session with the same buffer of the excerpted script. <br>
64+
<i>The excerpted script won't necessarily be the same.</i>
65+
</p>
66+
4967
## Setup
5068
### Prerequisites
5169
<p>

doc/usage.gif

27.2 KB
Loading

0 commit comments

Comments
 (0)