Skip to content

Commit 5874cb8

Browse files
authored
Merge pull request #82 from ManimCommunity/update-readme
Added BasicTeX installation instructions for MacOS
2 parents d1ddf94 + ee64928 commit 5874cb8

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Before installing `manim-community`, there are some additional dependencies that
7878

7979
#### LaTeX Installation
8080
1. Download the MiKTex installer from its [Download Page](https://miktex.org/download)
81-
2. You can check you did it right by running `refreshenv` to update your environment variable and running `latex`
81+
2. You can check you did it right by running `refreshenv` to update your environment variable and running `latex`
8282

8383
<img style="width: 20vw;" src="./readme-assets/windows_miktex.png" />
8484
<br><br>
@@ -108,7 +108,7 @@ Before installing `manim-community`, there are some additional dependencies that
108108
sudo apt install texlive texlive-latex-extra texlive-fonts-extra texlive-latex-recommended texlive-science texlive-fonts-extra tipa
109109
```
110110
> Note: this installation may take up a lot of space. The developers are working on providing a simpler, lighter LaTeX package for you to install
111-
2. You can check you did it right by running `latex`
111+
2. You can check you did it right by running `latex`
112112

113113
#### Additional Installation Steps
114114
- You must install additional codecs to play MP4 files:
@@ -151,7 +151,22 @@ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/
151151
#### LaTeX Installation
152152
1. Refer to the section on Brew installation to see how to install `brew`
153153
2. Run `brew cask install mactex`
154-
2. You can check you did it right by running `latex`
154+
3. You can check you did it right by running `latex`
155+
156+
> Note that MacTeX will require at least 4.5GB of hard disk space and bandwidth.
157+
>
158+
> This is due to the fact that it installs every LaTeX addon package offered by [CTAN](https://ctan.org/). Only a few of these packages are required by Manim.
159+
>
160+
> If you would like a smaller LaTeX install which only contains the packages needed by Manim alone, consider installing BasicTeX and suitable packages with the instructions below. This will require about 1.5 GB of space and bandwidth.
161+
162+
If you have installed MacTeX and are comfortable with it, do not install BasicTeX.
163+
164+
1. Refer to the section on Brew installation to see how to install `brew`
165+
2. Run `brew cask install basictex`
166+
3. Ensure that the TeXLiveManager tool `tlmgr` works, by running `tlmgr --version` in the terminal.
167+
4. Run `sudo tlmgr install standalone preview doublestroke relsize fundus-calligra wasysym physics dvisvgm.x86_64-darwin dvisvgm rsfs wasy cm-super`
168+
4. Ensure that LaTeX works by running `latex` in the Terminal.
169+
155170

156171
### Installing Manim-Community itself
157172

@@ -170,7 +185,7 @@ executing either
170185
git clone [email protected]:ManimCommunity/manim.git
171186
```
172187

173-
or
188+
or
174189

175190
```sh
176191
git clone https://github.com/ManimCommunity/manim.git

0 commit comments

Comments
 (0)