Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Some advice to a format README #5

Open
TravorLZH opened this issue Jul 10, 2019 · 1 comment
Open

Some advice to a format README #5

TravorLZH opened this issue Jul 10, 2019 · 1 comment
Assignees
@TravorLZH @malhotra5
Labels
enhancement New feature or request
Projects
Formatting for feasibility
Milestone
Repo Update for b...

Comments

@TravorLZH
Copy link
Contributor

README created by @malhotra5 explains everything carefully about the tutorial of manim. However I believe there are still methods to let README both look better and be synchronized to manim's update:

  1. Formatting: There are many syntax in markdown to express different types of content, and I suggest that we could adopt those other syntaxes in README
  2. Outdated parts: There is no need to obtain manim's repository now because it is made available to pip interface, so we really should change these.
  3. More information can be added to README: After reading its the source code, I have more understanding in manim's process of creating animations.

By the way, I also request assigning this issue to myself since I have already started working on the solutions in my fork of this repo.
@TravorLZH
Copy link
Contributor Author

Because I am developing these on a Mac, I can also put guide for installing manim on a computer running OSX

TravorLZH added a commit to TravorLZH/Manim-Tutorial that referenced this issue Jul 10, 2019
@TravorLZH
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
@malhotra5 malhotra5 reopened this Jul 12, 2019
@malhotra5 malhotra5 added the enhancement New feature or request label Jul 12, 2019
@malhotra5 malhotra5 added this to To do in Formatting for feasibility via automation Jul 12, 2019
@malhotra5 malhotra5 added this to To do in Formatting for feasibility via automation Jul 12, 2019
@malhotra5 malhotra5 moved this from To do to In progress in Formatting for feasibility Jul 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@TravorLZH TravorLZH

@malhotra5 malhotra5

Labels
enhancement New feature or request
Projects
Formatting for feasibility
  
In progress
Milestone
Repo Update for better readability an...
Development

No branches or pull requests
2 participants
@TravorLZH @malhotra5