From 73107f50654e9b2a7d23ae75f680f7891e95f3d1 Mon Sep 17 00:00:00 2001 From: Federico Galatolo Date: Mon, 28 Jun 2021 20:19:36 +0200 Subject: [PATCH] Updated readme --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9893b49..745fe11 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ To start the presentation using `Scene1`, `Scene2` and so on simply run: manim_presentation Scene1 Scene2... ``` -## Default Keybindings +## Keybindings Default keybindings to control the presentation @@ -67,7 +67,13 @@ Default keybindings to control the presentation | Q | Quit | -You can specify different keybindings creating a file named `manim-presentation.json` with the keys: `QUIT_KEY` `CONTINUE_KEY` `BACK_KEY` `REWIND_KEY` and `PLAYPAUSE_KEY` +You can run the **configuration wizard** with + +``` +manim-presentation-wizard +``` + +Alternatively you can specify different keybindings creating a file named `manim-presentation.json` with the keys: `QUIT_KEY` `CONTINUE_KEY` `BACK_KEY` `REWIND_KEY` and `PLAYPAUSE_KEY` `manim-presentation` uses `cv2.waitKeyEx()` to wait for keypresses ## Run Example @@ -86,7 +92,7 @@ virtualenv --python=python3.7 env . ./env/bin/activate ``` -Install `manim` and `manim_presentation` +Install `manim` and `manim-presentation` ``` pip install manim manim-presentation opencv-python @@ -101,7 +107,7 @@ manim -qh example.py Run the presentation ``` -manim_presentation Example +manim-presentation Example ``` ## Contributions and license