Skip to content

Commit

Permalink
doc(readme): add a note about windows support
Browse files Browse the repository at this point in the history
Also moved these notes to a different section at the bottom.

See #14 for details.
  • Loading branch information
Samyak2 committed Apr 4, 2022
1 parent 84e819f commit d06e104
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,11 @@ A trusty terminal typing tester.

# Usage

Note: toipe was only tested on Linux. If you find any problems, please [open an issue](https://github.com/Samyak2/toipe/issues).

## Install

### From GitHub

Go to the [latest release](https://github.com/Samyak2/toipe/releases/latest), scroll down to "Assets" and download the correct file for your platform (`.zip` in case of Windows and Mac OS, `.tar.gz` in case of Linux). Unzip the file and run the `toipe` binary inside.
Go to the [latest release](https://github.com/Samyak2/toipe/releases/latest), scroll down to "Assets" and download the correct file for your platform (`.zip` in case of Mac OS, `.tar.gz` in case of Linux). Unzip the file and run the `toipe` binary inside.

### From Cargo

Expand Down Expand Up @@ -75,6 +73,11 @@ You can provide your own word list too (Note: the word list must meet [these ass
toipe -w /path/to/word/list
```

# Platform support

- toipe was only tested on Linux. If you find any problems, please [open an issue](https://github.com/Samyak2/toipe/issues).
- Windows is not supported yet. Follow [this issue](https://github.com/Samyak2/toipe/issues/14) for updates. It should work on WSL though.

# License

MIT

0 comments on commit d06e104

Please sign in to comment.