chore(README): upgrade documentation in README #13
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| Using Manim Slides is a two-step process: | ||
| 1. Render animations using `Slide` (resp. `ThreeDSlide`) as a base class instead of `Scene` (resp. `ThreeDScene`), and add calls to `self.pause()` everytime you want to create a new slide. | ||
| 2. Run `manim-slides` on rendered animations and display them like a *Power Point* presentation. |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
Did you mean “PowerPoint” (= Microsoft presentation software)? (MICROSOFT_PRODUCTS[1])
Suggestions: PowerPoint
URL: https://languagetool.org/insights/post/camel-case/
Rule: https://community.languagetool.org/rule/show/MICROSOFT_PRODUCTS?lang=en-US&subId=1
Category: GRAMMAR
README.md
Outdated
| @@ -40,106 +75,105 @@ class Example(Slide): | |||
| dot = Dot() | |||
|
|
|||
| self.play(GrowFromCenter(circle)) | |||
| self.pause() | |||
| self.pause() # Wait use to press continue to go to the next slide | |||
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
Make sure that ‘use to’ is correct. For habitual actions in the past or to mean ‘accustomed to’, use “used to”. (USE_TO_VERB[1])
Suggestions: used to
URL: https://www.collinsdictionary.com/dictionary/english/used-to
Rule: https://community.languagetool.org/rule/show/USE_TO_VERB?lang=en-US&subId=1
Category: GRAMMAR
README.md
Outdated
|
|
||
| self.play(dot.animate.move_to(ORIGIN)) | ||
| self.pause() | ||
| self.pause() # Wait use to press continue to go to the next slide |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
Make sure that ‘use to’ is correct. For habitual actions in the past or to mean ‘accustomed to’, use “used to”. (USE_TO_VERB[1])
Suggestions: used to
URL: https://www.collinsdictionary.com/dictionary/english/used-to
Rule: https://community.languagetool.org/rule/show/USE_TO_VERB?lang=en-US&subId=1
Category: GRAMMAR
README.md
Outdated
| | Robust config file parsing | :heavy:checkmark: | :heavy_multiplication_x: | | ||
| | Support for 3D Scenes | :heavy:checkmark: | :heavy_multiplication_x: | | ||
| | Documented code | WIP | :heavy_multiplication_x: | | ||
| | Tested on Unix, MacOS, and Windows | :heavy:checkmark: | :heavy_multiplication_x: | |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
The operating system from Apple is written “macOS”. (MAC_OS[2])
Suggestions: macOS
URL: https://en.wikipedia.org/wiki/MacOS
Rule: https://community.languagetool.org/rule/show/MAC_OS?lang=en-US&subId=2
Category: GRAMMAR
README.md
Outdated
| | Robust config file parsing | :heavy:check_mark: | :heavy_multiplication_x: | | ||
| | Support for 3D Scenes | :heavy:check_mark: | :heavy_multiplication_x: | | ||
| | Documented code | WIP | :heavy_multiplication_x: | | ||
| | Tested on Unix, MacOS, and Windows | :heavy:check_mark: | :heavy_multiplication_x: | |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
The operating system from Apple is written “macOS”. (MAC_OS[2])
Suggestions: macOS
URL: https://en.wikipedia.org/wiki/MacOS
Rule: https://community.languagetool.org/rule/show/MAC_OS?lang=en-US&subId=2
Category: GRAMMAR
README.md
Outdated
| | Robust config file parsing | :heavy:check_mark: | :heavy_multiplication_x: | | ||
| | Support for 3D Scenes | :heavy:check_mark: | :heavy_multiplication_x: | | ||
| | Documented code | WIP | :heavy_multiplication_x: | | ||
| | Tested on Unix, MacOS, and Windows | :heavy:check_mark: | :heavy_multiplication_x: | |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
The operating system from Apple is written “macOS”. (MAC_OS[2])
Suggestions: macOS
URL: https://en.wikipedia.org/wiki/MacOS
Rule: https://community.languagetool.org/rule/show/MAC_OS?lang=en-US&subId=2
Category: GRAMMAR
README.md
Outdated
| | Robust config file parsing | :heavy_check_mark: | :heavy_multiplication_x: | | ||
| | Support for 3D Scenes | :heavy_check_mark: | :heavy_multiplication_x: | | ||
| | Documented code | WIP | :heavy_multiplication_x: | | ||
| | Tested on Unix, MacOS, and Windows | :heavy_check_mark: | :heavy_multiplication_x: | |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
The operating system from Apple is written “macOS”. (MAC_OS[2])
Suggestions: macOS
URL: https://en.wikipedia.org/wiki/MacOS
Rule: https://community.languagetool.org/rule/show/MAC_OS?lang=en-US&subId=2
Category: GRAMMAR
This gives a high upgrade to the README