Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 1.26 KB

README.md

File metadata and controls

45 lines (31 loc) · 1.26 KB
Raw

termracer

Practise your typing skills from within your terminal. termracer is inspired by various online typing tutor websites.

The Goal is to type a given paragraph as fast and accurate as possible, termracer will calculate your typing speed with words per minute and accuracy % metrics. You can also view your progress by viewing the past race results.

For each race, You'll be presented a paragraph randomly picked from a predefined pool of paragraphs.

Install

# Download and install latest release
# You could use -o flag to put the termracer binary anywhere that is included in $PATH
    $ go build -o $GOPATH/bin/termracer github.com/jan25/termracer/cmd

# Run application
# if $GOPATH/bin is in $PATH
    $ termracer
# OR use
    $ $GOPATH/bin/termracer

Development

This application uses go modules. So, you could clone this repo under any directory and build/test/run. As a helper we have Makefile in this repo, which will allow to build/test/run with single command.

# Run available tests
$ make test

# Build and Run executable
$ make run

# Build and Run in debug mode
$ make debug

# Builds executable
$ make build

The design/features are written in NOTES.md.