@@ -16,8 +16,9 @@ Tool for live presentations using either [Manim (community edition)](https://www
1616- [ Usage] ( #usage )
1717 * [ Basic Example] ( #basic-example )
1818 * [ Key Bindings] ( #key-bindings )
19+ * [ Interactive Tutorial] ( #interactive-tutorial )
1920 * [ Other Examples] ( #other-examples )
20- - [ Features and Comparison with Original manim-presentation ] ( #features-and- comparison-with-original-manim-presentation )
21+ - [ Comparison with Similar Tools ] ( #comparison-with-similar-tools )
2122- [ F.A.Q] ( #faq )
2223 * [ How to increase quality on Windows] ( #how-to-increase-quality-on-windows )
2324- [ Contributing] ( #contributing )
@@ -134,6 +135,12 @@ manim-slides init
134135
135136> ** _ NOTE:_ ** ` manim-slides ` uses key codes, which are platform dependent. Using the configuration wizard is therefore highly recommended.
136137
138+ ## Interactive Tutorial
139+
140+ Click on the image to watch a slides presentation that explains you how to use Manim Slides.
141+
142+ [ ![ Manim Slides Docs] ( https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/docs.png )] ( https://eertmans.be/manim-slides/ )
143+
137144## Other Examples
138145
139146Other examples are available in the [ ` example.py ` ] ( https://github.com/jeertmans/manim-slides/blob/main/example.py ) file, if you downloaded the git repository.
@@ -143,27 +150,21 @@ Below is a small recording of me playing with the slides back and forth.
143150![ ] ( https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/example.gif )
144151
145152
146- ## Features and Comparison with original manim-presentation
147-
148- Below is a non-exhaustive list of features:
149-
150- | Feature | ` manim-slides ` | ` manim-presentation ` |
151- | :--------| :--------------:| :--------------------:|
152- | Support for Manim | :heavy_check_mark : | :heavy_check_mark : |
153- | Support for ManimGL | :heavy_check_mark : | :heavy_multiplication_x : |
154- | Configurable key bindings | :heavy_check_mark : | :heavy_check_mark : |
155- | Configurable paths | :heavy_check_mark : | :heavy_multiplication_x : |
156- | Play / Pause slides | :heavy_check_mark : | :heavy_check_mark : |
157- | Next / Previous slide | :heavy_check_mark : | :heavy_check_mark : |
158- | Replay slide | :heavy_check_mark : | :heavy_check_mark : |
159- | Reverse slide | :heavy_check_mark : | :heavy_multiplication_x : |
160- | Multiple key per actions | :heavy_check_mark : | :heavy_multiplication_x : |
161- | One command line tool | :heavy_check_mark : | :heavy_multiplication_x : |
162- | Robust config file parsing | :heavy_check_mark : | :heavy_multiplication_x : |
163- | Support for 3D Scenes | :heavy_check_mark : | :heavy_multiplication_x : |
164- | Documented code | :heavy_check_mark : | :heavy_multiplication_x : |
165- | Tested on Unix, macOS, and Windows | :heavy_check_mark : | :heavy_multiplication_x : |
166- | Hide mouse cursor | :heavy_check_mark : | :heavy_multiplication_x : |
153+ ## Comparison with Similar Tools
154+
155+ There exists are variety of tools that allows to create slides presentations containing Manim animations.
156+
157+ Below is a comparison of the most used ones with Manim Slides:
158+
159+ | Project name | Manim Slides | Manim Presentation | Manim Editor | Jupyter Notebooks |
160+ | :------------:| :------------:| :------------------:| :------------:| :-----------------:|
161+ | Link | [ ![ GitHub Repo stars] ( https://img.shields.io/github/stars/jeertmans/manim-slides?style=social )] ( https://github.com/jeertmans/manim-slides ) | [ ![ GitHub Repo stars] ( https://img.shields.io/github/stars/galatolofederico/manim-presentation?style=social )] ( https://github.com/galatolofederico/manim-presentation ) | [ ![ GitHub Repo stars] ( https://img.shields.io/github/stars/ManimCommunity/manim_editor?style=social )] ( https://github.com/ManimCommunity/manim_editor ) | [ ![ GitHub Repo stars] ( https://img.shields.io/github/stars/jupyter/notebook?style=social )] ( https://github.com/jupyter/notebook ) |
162+ | Activity | [ ![ GitHub Repo stars] ( https://img.shields.io/github/last-commit/jeertmans/manim-slides?style=social )] ( https://github.com/jeertmans/manim-slides ) | [ ![ GitHub Repo stars] ( https://img.shields.io/github/last-commit/galatolofederico/manim-presentation?style=social )] ( https://github.com/galatolofederico/manim-presentation ) | [ ![ GitHub Repo stars] ( https://img.shields.io/github/last-commit/ManimCommunity/manim_editor?style=social )] ( https://github.com/ManimCommunity/manim_editor ) | [ ![ GitHub Repo stars] ( https://img.shields.io/github/last-commit/jupyter/notebook?style=social )] ( https://github.com/jupyter/notebook ) |
163+ | Usage | Command-line | Command-line | Web Browser | Notebook |
164+ | Note | Requires minimal modif. in scenes files | Requires minimal modif. in scenes files | Requires the usage of sections, and configuration through graphical interface | Relies on ` nbconvert ` to create slides from a Notebook |
165+ | Support for ManimGL | Yes | No | No | No |
166+ | Web Browser presentations | Yes | No | Yes | No |
167+ | Offline presentations | Yes, with Qt | Yes, with OpenCV | No | No
167168
168169## F.A.Q
169170
0 commit comments