typefast

command module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 17, 2024 License: MIT Imports: 8 Imported by: 0

README

Command-line typing test, built using Bubble Tea framework

How to run

You need to have Go installed (https://go.dev/doc/install)

Clone project

Create and enter the directory where project will be cloned:

$ mkdir typefast
$ cd typefast

Clone typefast:

$ git clone https://github.com/wdmiz/typefast

Build and run

On Linux or Mac:

$ go build
$ ./typefast <flags...>

On Windows:

$ go build
$ .\typefast.exe <flags...>

Alternatively you can run without building (for example, to quickly test changes in code)

Run without building

Inside directory where project was cloned, run:

$ go run . <flags...>

Run flags:

  • -words how many words should test consist of (default: 100)
  • -dict will randomly choose words from this file
  • -text if specified it will use text from this file as test text (-words and -dict will be ignored)

Example run commands

Using README.md as dictionary, test length 60 words

$ ./typefast -dict README.md -words 60

Using README.md as test text

$ ./typefast -text README.md

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL