Skip to content

Commit a781b30

Browse files
authored
Remove instructions for Docker on README (#2415)
1 parent 73dec41 commit a781b30

File tree

1 file changed

+2
-50
lines changed

1 file changed

+2
-50
lines changed

README.md

Lines changed: 2 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -100,56 +100,8 @@ Documentation is in progress at [ReadTheDocs](https://docs.manim.community/).
100100

101101
## Docker
102102

103-
The community also maintains a docker image (`manimcommunity/manim`), which can be found [on DockerHub](https://hub.docker.com/r/manimcommunity/manim). The following tags are supported:
104-
105-
- `latest` -- the most recent version corresponding to [the main branch](https://github.com/ManimCommunity/manim)
106-
- `stable` -- the latest released version (according to [the releases page](https://github.com/ManimCommunity/manim/releases))
107-
- `vX.Y.Z` -- any particular released version (according to [the releases page](https://github.com/ManimCommunity/manim/releases))
108-
109-
### Instructions for running the docker image
110-
111-
#### Quick Example
112-
To render a scene `CircleToSquare` in a file `test_scenes.py` contained in your current working directory while preserving your user and group ID, use
113-
114-
```sh
115-
docker run --rm -it --user="$(id -u):$(id -g)" -v "$(pwd)":/manim manimcommunity/manim manim test_scenes.py CircleToSquare -qm
116-
```
117-
118-
#### Running the image in the background
119-
120-
Instead of using the "throwaway container" approach sketched above, you can also create a named container that you can also modify to your liking. First, run
121-
122-
```sh
123-
docker run -it --name my-manim-container -v "$(pwd):/manim" manimcommunity/manim /bin/bash
124-
```
125-
126-
to obtain an interactive shell inside your container allowing you to, e.g., install further dependencies (like texlive packages using `tlmgr`). Exit the container as soon as you are satisfied. Then, before using it, start the container by running
127-
128-
```sh
129-
docker start my-manim-container
130-
```
131-
132-
Then, to render a scene `CircleToSquare` in a file `test_scenes.py`, call
133-
134-
```sh
135-
docker exec -it --user="$(id -u):$(id -g)" my-manim-container manim test.py CircleToSquare -qm
136-
```
137-
138-
#### Jupyterlab
139-
140-
Another alternative is to use the docker image to spin up a local webserver running
141-
JupyterLab in whose Python kernel manim is installed and can be accessed via the `%%manim` cell magic.
142-
To use JupyterLab, run
143-
144-
```sh
145-
docker run -it -p 8888:8888 manimcommunity/manim jupyter lab --ip=0.0.0.0
146-
```
147-
148-
and then follow the instructions in the terminal.
149-
150-
#### Important notes
151-
152-
When executing `manim` within a Docker container, several command line flags (in particular `-p` (preview file) and `-f` (show output file in the file browser)) are not supported.
103+
The community also maintains a docker image (`manimcommunity/manim`), which can be found [on DockerHub](https://hub.docker.com/r/manimcommunity/manim).
104+
Instructions on how to install and use it can be found in our [documentation](https://docs.manim.community/en/stable/installation/docker.html).
153105

154106
## Help with Manim
155107

0 commit comments

Comments
 (0)