aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: f973797fe654ee05fd11b5e7f0f68987af4db40d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# 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
```
make
```

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.