69 lines
1.7 KiB
Markdown
69 lines
1.7 KiB
Markdown
# What
|
|
|
|
A terminal based typing test.
|
|
|
|
|
|
|
|
# Installation
|
|
|
|
```
|
|
git clone github.com/lemnos/tt
|
|
make && sudo make install
|
|
```
|
|
|
|
or
|
|
|
|
`go get github.com/lemnos/tt` if you have $GOPATH/bin in your $PATH
|
|
|
|
Binaries are also available:
|
|
|
|
## OSX
|
|
|
|
```
|
|
sudo curl https://raw.githubusercontent.com/lemnos/tt/master/binaries/tt-osx_amd64 -o /usr/local/bin/tt && sudo chmod +x /usr/local/bin/tt
|
|
```
|
|
|
|
## Linux
|
|
|
|
```
|
|
sudo curl https://raw.githubusercontent.com/lemnos/tt/master/binaries/tt-linux_amd64 -o /usr/local/bin/tt && sudo chmod +x /usr/local/bin/tt
|
|
```
|
|
|
|
Best served on a terminal with truecolor and cursor shape support (e.g kitty, iterm)
|
|
|
|
# Usage
|
|
|
|
## Options
|
|
|
|
- `tt -n <num>` produces a test consisting of *num* randomly drawn english words
|
|
- `tt -csv` outputs the csv formatted results to STDOUT
|
|
|
|
The default behaviour is equivalent to 'tt -n 50'
|
|
|
|
## Keys
|
|
|
|
- Pressing `escape` at any point restarts the test.
|
|
- `C-c` exits the test.
|
|
|
|
Custom text can be supplied by piping aribirary text to the program. Each paragraph
|
|
in the input is shown as a separate segment of the text.
|
|
|
|
See -help for additional options.
|
|
|
|
E.G
|
|
|
|
- `shuf -n 40 /etc/dictionaries-common/words|tt` produces a test consisting of 40 random words drawn from `/etc/dictionaries-common/words`.
|
|
|
|
Note that line breaks are determined by the input if -raw is specified.
|
|
|
|
# Configuration
|
|
|
|
The theme can be configured by setting the following options in `~/.ttrc`:
|
|
|
|
- bgcol: The default background colour.
|
|
- fgcol: The default text colour.
|
|
- hicol: The colour used to highlight typed text.
|
|
- hicol2 The colour used to highlight the current word.
|
|
- hicol3: The colour used to highlight the next word.
|
|
- errcol: The colour used to highlight errors.
|