Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
nathom committed May 15, 2021
1 parent a20729d commit 69794e5
Showing 1 changed file with 29 additions and 4 deletions.
33 changes: 29 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,46 @@ A typingtest for terminal power users.

## Usage

Ensure you have `ncurses` installed. You can do this with Homebrew

```bash
brew install ncurses
```

Clone this repository

```bash
git clone https://github.com/nathom/typingterm
```

Change into the directory and compile the program
Change into the directory, compile, and link the binary.

```
cd typingterm && make install
```

Run the program with

```
cd typingterm && make
typingterm
```

Run the program
or

```
./typingtest
tterm
```

If you don't want to link the binary, you can just run `make` with no args.



```bash
❯ tterm -h
Usage: typingterm [OPTIONS]

-t, --time Test duration, in seconds. Default 15.
-f, --file The file containing the word bank. Default 200_top_words.txt.
-d, --delimeter The character separating words in the file. Default '\n'.
-h, --help Show this help message.
```

0 comments on commit 69794e5

Please sign in to comment.