Skip to content

Commit

Permalink
v0.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
dustin-ward committed Mar 7, 2024
1 parent cd46c11 commit 5d3528d
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,25 @@
# Term-Typing ⌨️🧠
# ttype ⌨️🧠
## A Terminal-Based Typing App

![Screenshot of the interface](https://github.com/dustin-ward/Term-Typing/blob/master/images/v0.1.0UI.png)
![Screenshot of the interface](https://github.com/dustin-ward/Term-Typing/blob/master/images/v0.3.0UI.png)

### Usage

After executing the program, the text will appear greyed out. This means the keyboard is not active. Simply press 'enter' to begin typing.

Green characters have been correctly typed, while a red character means a wrong input has been received. You cannot advance until the correct key has been pressed.

Pressing 'enter' while typing will re-generate a new set of words and reset your position. Pressing 'esc' will return the application to the inactive state.
Pressing 'enter' while typing will re-generate a new set of words and reset your position. Pressing 'esc' will return the application to the inactive state and reset your typing progress.

The program can be exited with 'ctrl+c' at any point in time, and with 'q' & 'esc' while in the inactive state.
You can exit the program by pressing 'esc'.

### Zen Mode 🧘

Pass the `-zen` flag to the program to enter zen mode.

Zen mode removes the status bar for a stress-free typing environment.

![Screenshot of the interface in zen mode](https://github.com/dustin-ward/Term-Typing/blob/master/images/v0.3.0UI_zen.png)

### Installation
The only installation requirement is the Golang compiler.
Expand Down
Binary file added images/v0.3.0UI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/v0.3.0UI_zen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5d3528d

Please sign in to comment.