public-mirrors/3b1b-manim
1
0
Fork 0
mirror of https://github.com/3b1b/manim.git synced 2025-08-05 16:49:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update docs for pip install

Browse source
This commit is contained in:
Tony031218 2021-02-15 12:23:53 +08:00
parent f9b1167d14
commit 2f202e26b2
2 changed files with 41 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
README.md
View file

@ -4,9 +4,10 @@
</a> </a>
</p> </p>
[![pypi version](https://img.shields.io/pypi/v/manimgl?logo=pypi)](https://pypi.org/project/manimgl/)
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://choosealicense.com/licenses/mit/) [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://choosealicense.com/licenses/mit/)
[![Manim Subreddit](https://img.shields.io/reddit/subreddit-subscribers/manim.svg?color=ff4301&label=reddit)](https://www.reddit.com/r/manim/) [![Manim Subreddit](https://img.shields.io/reddit/subreddit-subscribers/manim.svg?color=ff4301&label=reddit&logo=reddit)](https://www.reddit.com/r/manim/)
[![Manim Discord](https://img.shields.io/discord/581738731934056449.svg?label=discord)](https://discord.gg/mMRrZQW) [![Manim Discord](https://img.shields.io/discord/581738731934056449.svg?label=discord&logo=discord)](https://discord.gg/mMRrZQW)
[![docs](https://github.com/3b1b/manim/workflows/docs/badge.svg)](https://3b1b.github.io/manim/) [![docs](https://github.com/3b1b/manim/workflows/docs/badge.svg)](https://3b1b.github.io/manim/)
Manim is an engine for precise programatic animations, designed for creating explanatory math videos. Manim is an engine for precise programatic animations, designed for creating explanatory math videos.
@ -18,12 +19,21 @@ Since the fork, this version has evolved to work on top of OpenGL, and allows re
## Installation ## Installation
Manim runs on Python 3.6 or higher (Python 3.8 is recommended). Manim runs on Python 3.6 or higher (Python 3.8 is recommended).
System requirements are [FFmpeg](https://ffmpeg.org/), [OpenGL](https://www.opengl.org//) and [LaTeX](https://www.latex-project.org) (optional, if you want to use LaTeX). System requirements are [FFmpeg](https://ffmpeg.org/), [OpenGL](https://www.opengl.org/) and [LaTeX](https://www.latex-project.org) (optional, if you want to use LaTeX).
For more options, take a look at the [Using manim](#using-manim) sections further below.
### Directly ### Directly
```sh
# Install manimgl
pip install manimgl
# Try it out
manimgl
```
For more options, take a look at the [Using manim](#using-manim) sections further below.
If you want to hack on manimlib itself, clone this repository and in that directory execute: If you want to hack on manimlib itself, clone this repository and in that directory execute:
```sh ```sh
@ -35,7 +45,21 @@ manimgl example_scenes.py OpeningManimExample
# or # or
manim-render example_scenes.py OpeningManimExample manim-render example_scenes.py OpeningManimExample
``` ```
### Directly (Windows)
1. [Install FFmpeg](https://www.wikihow.com/Install-FFmpeg-on-Windows).
2. Install a LaTeX distribution. [MiKTeX](https://miktex.org/download) is recommended.
3. Install the remaining Python packages.
```sh
git clone https://github.com/3b1b/manim.git
cd manim
pip install -e .
manimgl example_scenes.py OpeningManimExample
```
### Mac OSX ### Mac OSX
1. Install FFmpeg, LaTeX in terminal using homebrew. 1. Install FFmpeg, LaTeX in terminal using homebrew.
```sh ```sh
brew install ffmpeg mactex brew install ffmpeg mactex
@ -49,23 +73,12 @@ manim-render example_scenes.py OpeningManimExample
manimgl example_scenes.py OpeningManimExample manimgl example_scenes.py OpeningManimExample
``` ```
### Directly (Windows)
1. [Install FFmpeg](https://www.wikihow.com/Install-FFmpeg-on-Windows).
2. Install a LaTeX distribution. [MiKTeX](https://miktex.org/download) is recommended.
3. Install the remaining Python packages.
```sh
git clone https://github.com/3b1b/manim.git
cd manim
pip install -e .
manimgl example_scenes.py OpeningManimExample
```
## Anaconda Install ## Anaconda Install
* Install LaTeX as above. 1. Install LaTeX as above.
* Create a conda environment using `conda create -n manim python=3.8`. 2. Create a conda environment using `conda create -n manim python=3.8`.
* Activate the environment using `conda activate manim`. 3. Activate the environment using `conda activate manim`.
* Install manimgl using `pip install -e .`. 4. Install manimgl using `pip install -e .`.
## Using manim ## Using manim

10
docs/source/getting_started/installation.rst
View file

@ -1,7 +1,7 @@
Installation Installation
============ ============
Manim runs on Python 3.8. Manim runs on Python 3.6 or higher (Python 3.8 is recommended).
System requirements are： System requirements are：
@ -12,6 +12,14 @@ System requirements are：
Directly Directly
-------- --------
.. code-block:: sh
# Install manimgl
pip install manimgl
# Try it out
manimgl
If you want to hack on manimlib itself, clone this repository and in If you want to hack on manimlib itself, clone this repository and in
that directory execute: that directory execute: