doman/fasttyper
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update readme

Browse source
This commit is contained in:
ickyicky 2022-02-12 22:52:04 +01:00 committed by GitHub
parent f86e5f892b
commit c35fac8dcc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -13,9 +13,13 @@ _Fasttyper_ is currently maintained on [PyPi](https://pypi.org/) Python Package
# Usage
With installation of fasttyper you should have new executable - `fasttyper`. It takes two optional positional arguments, amount of words and language (like in monkeytype: english, english_1k etc).
With installation of fasttyper you should have new executable - `fasttyper`. It takes two optional positional arguments, amount of words and language (like in [Monkeytype's](https://github.com/Miodec/monkeytype): english, english_1k etc). Default amount of words is 25 and language is english. To run fasttyper simply call:
Avalibe options:
```bash
fasttyper
```
from command line. There are some avalibe options:
```
usage: fasttyper [-h] [--config FILE] [--unclutter-backspace] [--no-cursor] [amount] [language]
@ -39,7 +43,13 @@ I personally use alias:
alias ff='fasttyper -n`
```
because i don't like having cursor.
because i don't like having cursor and i am too lazy to type fasttyper so i just type ff :)
# Running next test and stopping application
To abandon test and start brand new one, press TAB and then ENTER.
To kill application (exit) press CTRL+C.
# Usage as module, piping stuff, custom scripts etc