Skip to content

Commit 4d314ac

Browse files
committed
Update documentation to show strokes meter and new definition of "word"
1 parent 498b66d commit 4d314ac

File tree

3 files changed

+17
-4
lines changed

3 files changed

+17
-4
lines changed

README.md

+17-4
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,30 @@
11
# About
22

3-
This is a plugin for Plover to display your typing speed, in words per minute,
4-
as you type. Words per minute is calculated in one of two ways:
3+
This is a plugin for Plover to display your typing speed as you type, in either
4+
or both of words per minute or strokes per minute:
5+
6+
* **Words per minute**: Shows the rate at which you stroked words in the last
7+
10 and 60 seconds.
8+
* **Strokes per minute**: Shows how efficiently you stroked words in the last
9+
10 and 60 seconds. Lower values are more efficient, e.g. a value of 1 means
10+
that on average it took you one stroke to write out a word.
11+
12+
A word is defined in one of three ways:
513

614
* **NCRA**: The [National Court Reporters Association](https://www.ncra.org/)
715
defines a "word" as 1.4 syllables. This is the measure used for official
816
NCRA testing material.
917
* **Traditional**: The traditional metric for "word" in the context of
10-
keyboarding is defined to be 5 characters per word, including spaces.
18+
keyboarding is defined to be 5 characters per word, including spaces. This
19+
is compatible with the notion of "word" in many typing speed utilities.
20+
* **Spaces**: A word is a whitespace-separated sequence of characters. This
21+
metric of course doesn't take into account the fact that some words are
22+
longer than others, both in length and syllables.
1123

12-
It looks like this:
24+
The meters look like this:
1325

1426
![The WPM meter in action](media/wpm-meter.png)
27+
![The strokes meter in action](media/strokes-meter.png)
1528

1629
# Installation
1730

media/strokes-meter.png

16.3 KB
Loading

media/wpm-meter.png

2.06 KB
Loading

0 commit comments

Comments
 (0)