2 releases
| 0.1.1 | Jun 7, 2024 |
|---|---|
| 0.1.0 | May 30, 2024 |
#1066 in Command line utilities
257 downloads per month
30KB
649 lines
booktyping
booktyping is a simple commandline tool for practicing typing accuracy while reading a book.
Installation
booktyping has only been tested on linux, but should work on Windows and MacOS. The only dependency is rust.
Clone this repository and run
cargo build --release
This will generate an executable file in booktyping/target/release/.
Usage
Find a text copy of your favorite book, and place it in $HOME/.booktyping/{book_title}.txt. Now run booktyping with
./booktyping run {book_title}
Your progress will be automatically saved, and JSON logs of your keypresses and your sample completions will be saved in $HOME/.booktyping/{book_title}/keypresses.json and $HOME/.booktyping/{book_title}/tests.json respectively.
License
Licensed under either of Apache License, Version 2.0 or MIT license at your option.Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Dependencies
~12–25MB
~310K SLoC