Completing #5 #6
Conversation
* README.md: Add installation guide for Mac OSX, and use TexMobject for equations in the LaTeX tutorial (It's spelled as `LaTeX` instead of `LaTex`). See more in README.md
* README.md: Add one space after each `#`
* README.md: Do not show links directly
| @@ -1,11 +1,11 @@ | |||
| # Manim-Tutorial | |||
| A tutorial for manim, a mathematical animation engine made by 3b1b for Python. | |||
| ## Requirements | |||
There was a problem hiding this comment.
You don't have to entirely remove the req section. This guide is for everyone, including beginners. In the past, there have been beginners that have used this. So, leave the req section with Python as one of the reqs, and change linux to mac, linux or window.
There was a problem hiding this comment.
Keep Original. I will change it
README.md
Outdated
| ## Table of Contents | ||
| * [Installations](#Installations) | ||
| * [Common Problems](#Common-Problems) | ||
| * [Linux](#Linux) |
There was a problem hiding this comment.
Good Job with the Mac addition.
| For subscripts, it is similar. | ||
|
|
||
| ```python | ||
| subScript_equation = TextMobject("$\\theta_{1}$") |
There was a problem hiding this comment.
The $ signify an equation. Even if it isn't required its good practice. It should be left there.
README.md
Outdated
|
|
||
| ``` bash | ||
| sudo apt install SystemReq | ||
| After having these libraries and tools installed in your computer, you can now type this command to finish the last step of the installation |
There was a problem hiding this comment.
Test that this works. As far as I know, this doesn't work yet on Linux or Windows.
There was a problem hiding this comment.
Keep original. Only add mac additions
README.md
Outdated
| ```shell | ||
| $ brew cask install mactex | ||
| ``` | ||
| Phew! This will be the last installation for additional python modules. Run this in the terminal |
README.md
Outdated
| $ pip3 install manim | ||
| ``` | ||
|
|
||
| ### Common-Problems |
| $ pip3 install pycairo | ||
| ``` | ||
|
|
||
| * Problem #2: **Exception: Latex error converting to dvi. See log output above or the log file** |
There was a problem hiding this comment.
Keep original. I will take all your syntax changes into account, and give you credit for it.
README.md
Outdated
| $ manim pythonFile.py SceneName options... | ||
| ``` | ||
|
|
||
| **NOTE 1**: Your videos that you make are saved in the folder called *media*. \ |
| ``` | ||
|
|
||
| We will break this into parts: | ||
| * Import: The import in this code is the import we will use in all manim projects. It has almost all the imports we will ever require |
README.md
Outdated
| * **construct()** method: While creating animation for a scene, manim creates an object for the specific scene class. According to the source code of [`manimlib/scene/scene.py`][scene_source], after being run from `__init__()`, the Scene class itself calls `construct()`, so put your animation code in `construct()` if you want manim to render them. | ||
| * Code: You don't have to fully understand how the code works yet. But you can see that you first define your animations, and then you display it. You can experiment with the order in which you define and display. | ||
|
|
||
| **NOTE**: If you recall, to run this animation, you would run the following in the terminal - |
README.md
Outdated
| ``` | ||
| After looking at a lot of pieces of code in this tutorial, you will eventually familiarize yourself with manim. So lets start! | ||
|
|
||
| Our focus is going to shift from understanding the structure of our code, to understanding the code itself. The first import statement imports many of the classes we will use. |
| * FadeOut | ||
| * GrowFromCenter | ||
|
|
||
| **Adding:** |
| * Add | ||
|
|
||
| In this code, I specifically included an example that I found useful to know. | ||
| ``` python |
There was a problem hiding this comment.
This was changed in another commit. That has been taken into account. Ignore this.
README.md
Outdated
|
|
||
| [](https://www.youtube.com/watch?v=3pxIVQxlpRQ) | ||
|
|
||
| ### Math-Equations |
There was a problem hiding this comment.
These header addition are good. Keep them.
README.md
Outdated
| That looks long, but it's very simple. Here I have provided 2 ways of making equation and displaying it to the screen. If you remember, we installed some latex system requirements. We will use LaTex to make our equations look nice. | ||
| That looks long, but it's very simple. Here I have provided 2 ways of making equation and displaying it to the screen. If you remember, we installed some latex system requirements. We will use LaTeX to make our equations look nice. | ||
|
|
||
| LaTex will take it's own tutorial. However, you don't need to know a lot of LaTex. I will introduce some rules that will help you write any math equation. Notice that equations are specified in TextMobjects. |
README.md
Outdated
| superScript_equation = TexMobject("r^{\\theta}") | ||
| ``` | ||
|
|
||
| The ^ symbol signifies superscript. We put the symbol theta as the superscript. Also, when specifying superscript the {} brackets are not displayed in the equation. They help group all the elements you want to add to the superscript. |
README.md
Outdated
| ## Further Work | ||
| I am missing a lot of aspects behind this powerful library after reverse engineering manim. There are things such as 3D scenes that still need to be documented. But hopefully this guide will cater to your basic needs. | ||
| ## Acknowledgements | ||
| * 3 Blue 1 Brown: The creator of this engine who uses it for creating cool math videos. Visit his YouTube channel and manin repo at |
There was a problem hiding this comment.
I don't think I will approve this yet. There are parts where you are knit picking my style of writing. I understand that there are problems with it as I wrote it in a rush, but I want to fix that myself. So, leave that to me and just keep the Mac installation. My comments will specify whether to keep original versions of the README or update it with your version.
There was a problem hiding this comment.
I don't think I will approve this yet. There are parts where you are knit picking my style of writing. I understand that there are problems with it as I wrote it in a rush, but I want to fix that myself. So, leave that to me and just keep the Mac installation. My comments will specify whether to keep original versions of the README or update it with your version.
| ### Basics | ||
| ``` python | ||
| from manimlib.imports import * | ||
|
|
There was a problem hiding this comment.
Everything looks good. Keep changes
|
|
||
| ## Putting it together | ||
| Manim is extremely powerful, and is capable of creating high quality graphics. You can make your animations using graphics and then overlay your voice over the video. | ||
|
|
There was a problem hiding this comment.
Everything looks good. Keep changes.
|
I am so sorry that I really did not have enough time to read and change
README according to your review. I wonder if I can revert everything but
only adding the Mac installation part. Or could I just delete my own fork
because the changing these content get _extremely_ hard since I put all of
them in **one** commit. I also plan to quit the task of editing README
since I have more ideas on the Reverse Engineering of Manim.
Best Wishes,
Travor Liu
…On Sat, 13 Jul 2019, Rohit Malhotra wrote:
@malhotra5 requested changes on this pull request.
I don't think I will approve this yet. There are parts where you are knit
picking my style of writing. I understand that there are problems with it as
I wrote it in a rush, but I want to fix that myself. So, leave that to me
and just keep the Mac installation. My comments will specify whether to keep
original versions of the README or update it with your version.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub, or mute thethread.[AF5X74IFUOXEIFTK5DR2A23P7JE4FA5CNFSM4IC2ITDKYY3PNVWWK3TUL52HS4DFWFI
HK3DMKJSXC5LFON2FEZLWNFSXPKTDN5WW2ZLOORPWSZGOB6LQ45Y.gif]
|
I put more details on the installation guide and tutorial, and I make corrections about formulas. More details can be found in the diff of the commits