Skip to content

Commit

Permalink
v0.3.0
Browse files Browse the repository at this point in the history
 - Added support for custom word lists (`-words).
 - `-theme` now accepts a path.
 - Added `~/.tt/themes` and `~/.tt/words`.
 - Scrapped ~/.ttrc in favour of aliases/flags.
 - Included more default word lists. (`-list words`)
  • Loading branch information
lemnos committed Jan 4, 2021
1 parent bb442d1 commit 955d28a
Show file tree
Hide file tree
Showing 204 changed files with 6,212 additions and 1,573 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# 0.3.0:
- Added support for custom word lists (`-words).
- `-theme` now accepts a path.
- Added `~/.tt/themes` and `~/.tt/words`.
- Scrapped ~/.ttrc in favour of aliases/flags.
- Included more default word lists. (`-list words`)

# 0.2.2:
- Modified -g to correspond to the number of groups rather than the group size.
- Added -multi
Expand Down
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ all:
install:
install -m755 bin/tt /usr/local/bin
assets:
python3 tools/themegen.py | gofmt > generatedThemes.go
python3 ./scripts/themegen.py
./scripts/pack themes/ words/ > packed.go
rel:
GOOS=darwin GOARCH=amd64 go build -o bin/tt-osx *.go
GOOS=windows GOARCH=amd64 go build -o bin/tt.exe *.go
Expand Down
18 changes: 6 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ A terminal based typing test.
## Linux

```
sudo curl -L https://github.com/lemnos/tt/releases/download/v0.2.2/tt-linux -o /usr/local/bin/tt && sudo chmod +x /usr/local/bin/tt
sudo curl -L https://github.com/lemnos/tt/releases/download/v0.3.0/tt-linux -o /usr/local/bin/tt && sudo chmod +x /usr/local/bin/tt
```

## OSX

```
sudo curl -L https://github.com/lemnos/tt/releases/download/v0.2.2/tt-osx -o /usr/local/bin/tt && sudo chmod +x /usr/local/bin/tt
sudo curl -L https://github.com/lemnos/tt/releases/download/v0.3.0/tt-osx -o /usr/local/bin/tt && sudo chmod +x /usr/local/bin/tt
```

## Windows
Expand Down Expand Up @@ -60,15 +60,10 @@ See `-help` for an exhaustive list of options.

## 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.
- `theme`: The theme from which default colors are drawn, a list of builtin themes can be obtained via `-list themes`.
Custom themes and word lists can be defined in `~/.tt/themes` and `~/.tt/words`
and used in conjunction with the `-theme` and `-words` flags. A list of
preloaded themes and word lists can be found in `words/` and `themes/` and are
accessible by default using the respective flags.

## Recipes

Expand All @@ -80,4 +75,3 @@ what can be achieved.
- `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`.

Loading

0 comments on commit 955d28a

Please sign in to comment.