Completing #5 #6

TravorLZH · 2019-07-13T10:05:30Z

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

* 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

malhotra5 · 2019-07-13T18:10:10Z

README.md

@@ -1,11 +1,11 @@
 # Manim-Tutorial
 A tutorial for manim, a mathematical animation engine made by 3b1b for Python. 
-## Requirements


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.

Keep Original. I will change it

malhotra5 · 2019-07-13T18:21:04Z

README.md

 ## Table of Contents
 * [Installations](#Installations)
-  * [Common Problems](#Common-Problems)
+  * [Linux](#Linux)


Good Job with the Mac addition.

Keep Changes

malhotra5 · 2019-07-13T18:22:23Z

README.md


 For subscripts, it is similar. 

 ```python
-subScript_equation = TextMobject("$\\theta_{1}$")


The $ signify an equation. Even if it isn't required its good practice. It should be left there.

Keep Original

malhotra5

For the long term, I think these are good changes. Thanks for the insights.

malhotra5 · 2019-07-13T18:36:52Z

README.md


-``` 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


Test that this works. As far as I know, this doesn't work yet on Linux or Windows.

Keep original. Only add mac additions

malhotra5 · 2019-07-13T18:37:52Z

README.md

 ```
-Phew! This will be the last installation for additional python modules. Run this in the terminal 


Keep original

malhotra5 · 2019-07-13T18:38:02Z

README.md

 ```

-### Common-Problems


Keep Original

malhotra5 · 2019-07-13T18:38:50Z

README.md

 ```

-* Problem #2: **Exception: Latex error converting to dvi. See log output above or the log file**


Keep original. I will take all your syntax changes into account, and give you credit for it.

malhotra5 · 2019-07-13T18:39:44Z

README.md

 ```

-**NOTE 1**: Your videos that you make are saved in the folder called *media*. \


Keep Original

malhotra5 · 2019-07-13T18:39:57Z

README.md

@@ -112,14 +137,16 @@ class Shapes(Scene):
 ```

 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


Keep Original

malhotra5 · 2019-07-13T18:40:05Z

README.md

 * 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 - 


Keep original

malhotra5 · 2019-07-13T18:40:17Z

README.md

@@ -162,10 +189,10 @@ class Shapes(Scene):
 ```
 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. 


Keep Original

malhotra5 · 2019-07-13T18:40:31Z

README.md

@@ -182,27 +209,26 @@ The section for showing the animaton displays the shapes, as specified in the co
 * FadeOut
 * GrowFromCenter

-**Adding:**


Keep original

malhotra5 · 2019-07-13T18:41:10Z

README.md

 * Play
 * Add

 In this code, I specifically included an example that I found useful to know. 
-``` python


This was changed in another commit. That has been taken into account. Ignore this.

malhotra5 · 2019-07-13T18:53:59Z

README.md

@@ -250,7 +276,7 @@ TextMobjects will be used later on to write good looking math equations.

 [![Youtube video link](https://img.youtube.com/vi/3pxIVQxlpRQ/0.jpg)](https://www.youtube.com/watch?v=3pxIVQxlpRQ)

-### Math-Equations


These header addition are good. Keep them.

malhotra5 · 2019-07-13T18:54:10Z

README.md


-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. 


Keep Original

malhotra5 · 2019-07-13T18:54:23Z

README.md

 ```

-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. 


Keep Original

malhotra5 · 2019-07-13T18:55:03Z

README.md

 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 


Keep Original

malhotra5

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.

malhotra5

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.

malhotra5 · 2019-07-13T21:52:38Z

README.md

@@ -123,13 +123,13 @@ from manimlib.imports import *



Everything looks good. Keep changes

malhotra5 · 2019-07-13T21:53:02Z

README.md

@@ -571,10 +571,8 @@ Manim is extremely powerful, and is capable of creating high quality graphics. Y



Everything looks good. Keep changes.

TravorLZH · 2019-07-20T12:10:46Z

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]

TravorLZH added 3 commits July 10, 2019 17:33

Format README and add make some adjustments (malhotra5#5)

adc1ac9

* 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

Formatting comments and indentations of README.md

510a7da

* README.md: Add one space after each `#`

Eliminate explicit links

55f0452

* README.md: Do not show links directly