Skip to content

Completing #5#6

Open
TravorLZH wants to merge 4 commits intomalhotra5:masterfrom
TravorLZH:master
Open

Completing #5#6
TravorLZH wants to merge 4 commits intomalhotra5:masterfrom
TravorLZH:master

Conversation

@TravorLZH
Copy link
Contributor

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
@@ -1,11 +1,11 @@
# Manim-Tutorial
A tutorial for manim, a mathematical animation engine made by 3b1b for Python.
## Requirements
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep Original. I will change it

README.md Outdated
Copy link
Owner

@malhotra5 malhotra5 Jul 13, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good Job with the Mac addition.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep Changes

For subscripts, it is similar.

```python
subScript_equation = TextMobject("$\\theta_{1}$")
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep Original

Copy link
Owner

@malhotra5 malhotra5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

README.md Outdated
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep original. Only add mac additions

README.md Outdated
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep original

README.md Outdated
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep Original

$ pip3 install pycairo
```

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

README.md Outdated
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep Original

```

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
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep Original

README.md Outdated
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep original

README.md Outdated
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep Original

* FadeOut
* GrowFromCenter

**Adding:**
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep original

* Add

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

README.md Outdated
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These header addition are good. Keep them.

README.md Outdated
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep Original

README.md Outdated
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep Original

README.md Outdated
Copy link
Owner

@malhotra5 malhotra5 Jul 13, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep Original

Copy link
Owner

@malhotra5 malhotra5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Owner

@malhotra5 malhotra5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

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

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything looks good. Keep changes

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

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything looks good. Keep changes.

@TravorLZH
Copy link
Contributor Author

TravorLZH commented Jul 20, 2019 via email

@malhotra5 malhotra5 linked an issue Oct 20, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Some advice to a format README

2 participants

Comments