Skip to content

Commit 920d140

Browse files
authored
Merge pull request 3b1b#776 from MathWhiz/patch-1
README.md fixes
2 parents e1e66f3 + b163b1b commit 920d140

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<img src="logo/cropped.png"/>
1+
![logo](logo/cropped.png)
22

33
[![Build Status](https://travis-ci.org/3b1b/manim.svg?branch=master)](https://travis-ci.org/3b1b/manim)
44
[![Documentation](https://img.shields.io/badge/docs-EulerTour-blue.svg)](https://www.eulertour.com/learn/manim/)
@@ -9,7 +9,7 @@
99
Manim is an animation engine for explanatory math videos. It's used to create precise animations programmatically, as seen in the videos at [3Blue1Brown](https://www.3blue1brown.com/).
1010

1111
## Installation
12-
Manim runs on python 3.7. You can install it from PyPI via pip
12+
Manim runs on Python 3.7. You can install it from PyPI via pip:
1313

1414
```sh
1515
pip3 install manimlib
@@ -23,7 +23,7 @@ You can now use it via the `manim` command. For example:
2323
manim my_project.py MyScene
2424
```
2525

26-
For more options, take a look at the Using manim sections further below.
26+
For more options, take a look at the [Using manim](#using-manim) sections further below.
2727

2828
### Directly
2929

@@ -39,7 +39,7 @@ python3 ./manim.py example_scenes.py SquareToCircle -pl
3939

4040
### Directly (Windows)
4141
1. [Install FFmpeg](https://www.wikihow.com/Install-FFmpeg-on-Windows).
42-
2. Install Cairo. Download the wheel from https://www.lfd.uci.edu/~gohlke/pythonlibs/#pycairo. For most users, ``pycairo‑1.18.0‑cp37‑cp37m‑win32.whl`` will do fine.
42+
2. [Install Cairo](https://www.lfd.uci.edu/~gohlke/pythonlibs/#pycairo). For most users, ``pycairo‑1.18.0‑cp37‑cp37m‑win32.whl`` will do fine.
4343
```sh
4444
pip3 install C:\path\to\wheel\pycairo‑1.18.0‑cp37‑cp37m‑win32.whl
4545
```
@@ -81,7 +81,7 @@ environment variable to the absolute path containing your scene file and the
8181
8282
1. [Install Docker](https://docs.docker.com)
8383
2. [Install Docker Compose](https://docs.docker.com/compose/install/)
84-
3. Render an animation
84+
3. Render an animation:
8585
```sh
8686
INPUT_PATH=/path/to/dir/containing/source/code \
8787
OUTPUT_PATH=/path/to/output/ \
@@ -91,9 +91,9 @@ The command needs to be run as root if your username is not in the docker group.
9191
9292
You can replace `example.scenes.py` with any relative path from your `INPUT_PATH`.
9393
94-
<img src=./manim_docker_diagram.png/>
94+
![docker diagram](./manim_docker_diagram.png)
9595
96-
After running the output will say files ready at `/tmp/output/`, which refers to path inside the container. Your OUTPUT_PATH is bind mounted to this `/tmp/output` so any changes made by the container to `/tmp/output` will be mirrored on your OUTPUT_PATH. `/media/` will be created in `OUTPUT_PATH`.
96+
After running the output will say files ready at `/tmp/output/`, which refers to path inside the container. Your `OUTPUT_PATH` is bind mounted to this `/tmp/output` so any changes made by the container to `/tmp/output` will be mirrored on your `OUTPUT_PATH`. `/media/` will be created in `OUTPUT_PATH`.
9797
9898
`-p` won't work as manim would look for video player in the container system, which it does not have.
9999

@@ -108,22 +108,21 @@ python3 -m manim example_scenes.py SquareToCircle -pl
108108
The `-p` flag in the command above is for previewing, meaning the video file will automatically open when it is done rendering. The `-l` flag is for a faster rendering at a lower quality.
109109

110110
Some other useful flags include:
111-
112111
* `-s` to skip to the end and just show the final frame.
113112
* `-n <number>` to skip ahead to the `n`'th animation of a scene.
114113
* `-f` to show the file in finder (for OSX).
115114
116115
Set `MEDIA_DIR` environment variable to specify where the image and animation files will be written.
117116
118-
Look through the `old_projects` folder to see the code for previous 3b1b videos. Note, however, that developments are often made to the library without considering backwards compatibility with those old projects. To run an old project with a guarantee that it will work, you will have to go back to the commit which completed that project.
117+
Look through the `old_projects` folder to see the code for previous 3b1b videos. Note, however, that developments are often made to the library without considering backwards compatibility with those old projects. To run an old project with a guarantee that it will work, you will have to go back to the commit which completed that project.
119118
120-
While developing a scene, the `-sp` flags are helpful to just see what things look like at the end without having to generate the full animation. It can also be helpful to use the `-n` flag to skip over some number of animations.
119+
While developing a scene, the `-sp` flags are helpful to just see what things look like at the end without having to generate the full animation. It can also be helpful to use the `-n` flag to skip over some number of animations.
121120
122121
### Documentation
123122
Documentation is in progress at [eulertour.com/learn/manim](https://www.eulertour.com/learn/manim/).
124123
125124
### Walkthrough
126-
Todd Zimmerman put together a [tutorial](https://talkingphysics.wordpress.com/2019/01/08/getting-started-animating-with-manim-and-python-3-7/) on getting started with manim, which has been updated to run on python 3.7.
125+
Todd Zimmerman put together a [tutorial](https://talkingphysics.wordpress.com/2019/01/08/getting-started-animating-with-manim-and-python-3-7/) on getting started with manim, which has been updated to run on Python 3.7.
127126
128127
### Live Streaming
129128
To live stream your animations, simply run manim with the `--livestream` option.
@@ -141,8 +140,8 @@ them to manim.play(), e.g.
141140
```
142141
143142
It is also possible to stream directly to Twitch. To do that simply pass
144-
--livestream and --to-twitch to manim and specify the stream key with
145-
--with-key. Then when you follow the above example the stream will directly
143+
`--livestream` and `--to-twitch to manim` and specify the stream key with
144+
`--with-key`. Then when you follow the above example the stream will directly
146145
start on your Twitch channel (with no audio support).
147146
148147
@@ -151,6 +150,6 @@ Is always welcome. In particular, there is a dire need for tests and documentati
151150
152151
153152
## License
154-
All files in the directories active_projects and old_projects, which by and large generate the visuals for 3b1b videos, are copyright 3Blue1Brown.
153+
All files in the directories `active_projects` and `old_projects`, which by and large generate the visuals for 3b1b videos, are copyright 3Blue1Brown.
155154
156155
The general purpose animation code found in the remainder of the repository, on the other hand, is under the MIT license.

0 commit comments

Comments
 (0)