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.

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

Update README.md with instructions to run an example #75

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,42 @@ This almost entirely consists of scenes generated using the library [Manim](http
Note, while the library Manim itself is open source and under the MIT license, the contents of this project are intended only to be used for 3Blue1Brown videos themselves.

Copyright © 2022 3Blue1Brown

## Installation
1. Install `manimgl` [from source](https://github.com/3b1b/manim?tab=readme-ov-file#directly-windows) since the latest version published is not up to date.
2. Ensure Latex is installed, for example on Ubuntu
```sh
sudo apt install texlive
sudo apt install texlive-latex-extra
sudo apt install texlive-fonts-extra
sudo apt install texlive-science
```
3. Clone this repository to run the video samples
```sh
git clone [email protected]:3b1b/videos.git
cd videos
```

### Running a video

1. Setup includes (if you don't want to modify your path)
```sh
cd _2023/optics_puzzles
vi e_field.py
```
And add the following to the top
```python
import sys
sys.path.append(".")
sys.path.append("..")
sys.path.append("../..")
```

2. Run an example
```sh
manimgl e_field.py
```
Or
```sh
manimgl e_field.py WavesIn3D
```