Skip to content

Commit 0778ceb

Browse files
authored
chore(README): update key bindings documentation
1 parent 1632604 commit 0778ceb

File tree

1 file changed

+3
-11
lines changed

1 file changed

+3
-11
lines changed

README.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -119,30 +119,22 @@ manim-slides Example
119119

120120
The default key bindings to control the presentation are:
121121

122-
| Keybinding | Action |
123-
|:-----------:|:------------------------:|
124-
| Right Arrow | Continue/Next Slide |
125-
| Left Arrow | Previous Slide |
126-
| R | Replay Current Slide |
127-
| V | Reverse Current Slide |
128-
| Spacebar | Play/Pause |
129-
| Q | Quit |
122+
![manim-wizard](https://user-images.githubusercontent.com/27275099/197468787-19c83a81-d757-47b9-8f68-218427d30298.png)
123+
130124

131125
You can run the **configuration wizard** to change those key bindings:
132126

133127
```bash
134128
manim-slides wizard
135129
```
136130

137-
Alternatively you can specify different key bindings creating a file named `.manim-slides.json` with the keys: `QUIT` `CONTINUE` `BACK` `REVERSE` `REWIND` and `PLAY_PAUSE`.
138-
139131
A default file can be created with:
140132

141133
```bash
142134
manim-slides init
143135
```
144136

145-
> **_NOTE:_** `manim-slides` uses `cv2.waitKeyEx()` to wait for keypresses, and directly registers the key code.
137+
> **_NOTE:_** `manim-slides` uses key codes, which are platform dependent. Using the configuration wizard is therefore highly recommended.
146138
147139
## Other Examples
148140

0 commit comments

Comments
 (0)