Doc tweak
This commit is contained in:
24
README.md
24
README.md
@ -43,6 +43,17 @@ text.
|
||||
- Pressing `escape` at any point restarts the test.
|
||||
- `C-c` exits the test.
|
||||
|
||||
## Examples
|
||||
|
||||
- `tt -n 10` produces a test consisting of 10 randomly drawn english words
|
||||
- `tt -n 50 -g 5` produces a test consisting of 50 randomly drawn words in 5 groups of 10 words each.
|
||||
- `tt -t 10` starts a timed test consisting of 50 words
|
||||
- `tt -theme gruvbox` Starts tt with the gruvbox theme
|
||||
|
||||
The default behaviour is equivalent to `tt -n 50`.
|
||||
|
||||
See `-help` for an exhaustive list of options.
|
||||
|
||||
## Configuration
|
||||
|
||||
The theme can be configured by setting the following options in `~/.ttrc`:
|
||||
@ -55,17 +66,6 @@ The theme can be configured by setting the following options in `~/.ttrc`:
|
||||
- `errcol`: The colour used to highlight errors.
|
||||
- `theme`: The theme from which default colors are drawn, a list of builtin themes can be obtained via `-list themes`.
|
||||
|
||||
## Examples
|
||||
|
||||
- `tt -n 10` produces a test consisting of 10 randomly drawn english words
|
||||
- `tt -n 50 -g 5` produces a test consisting of 50 randomly drawn words in 5 groups of 10 words each.
|
||||
- `tt -t 10` starts a timed test consisting of 50 words
|
||||
- `tt -theme gruvbox` Starts tt with the gruvbox theme
|
||||
|
||||
The default behaviour is equivalent to `tt -n 50`.
|
||||
|
||||
See `-help` for an exhaustive list of options.
|
||||
|
||||
## Recipes
|
||||
|
||||
`tt` is designed to be easily scriptable and integrate nicely with other with
|
||||
@ -73,7 +73,7 @@ other *nix tools. With a little shell scripting most features the user can
|
||||
conceive of should be possible to implement. Below are some simple examples of
|
||||
what can be achieved.
|
||||
|
||||
- `shuf -n 40 /usr/local/dict/words|tt` Produces a test consisting of 40 random words drawn from your system's dictionary.
|
||||
- `shuf -n 40 /usr/share/dict/words|tt` Produces a test consisting of 40 random words drawn from your system's dictionary.
|
||||
- `curl http://api.quotable.io/random|jq -r .content|tt` Produces a test consisting of a random quote.
|
||||
- `alias ttd='tt -csv >> ~/wpm.csv'` Creates an alias called ttd which keeps a log of your progress in your home directory`.
|
||||
|
||||
|
Reference in New Issue
Block a user