diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 26 |
1 files changed, 25 insertions, 1 deletions
@@ -1,7 +1,16 @@ -# reader.cpp +# reader.cpp Terminal: RSVP (Rapid Serial Visual Presentation) +## // Features + +- Flashes words one at a time, centered in your terminal +- Highlights the middle character of each word in red to anchor your gaze +- Adjustable reading speed — change it on the fly while reading +- Pause and resume at any time +- Reads any plain text file +- Lock-free single-producer single-consumer input queue for clean keypress handling + ## // Getting started How to compile @@ -14,5 +23,20 @@ How to use: ./run <file_name> <time-interval> ``` +`<time-interval>` is optional. It sets the delay between words in microseconds. Defaults to `250000` (250ms). + +``` +./run book.txt 200000 +``` + +## // Keybinds + +| Key | Action | +|-----|--------| +| `Ctrl+p` | Pause / resume | +| `Ctrl+j` | Slow down (increase delay by 10ms) | +| `Ctrl+k` | Speed up (decrease delay by 10ms) | +| `Ctrl+q` | Quit | + ## // Licence Use of this code is not permisable for AI/LLM or any statistical prediction model training or any adjacent use. |