Skip to content

Commit 5db0261

Browse files
chore(docs): update install documentation (#175)
* chore(docs): update install documentation Closes #169 * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * chore(docs): update according to code quality report --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 8ab33ef commit 5db0261

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,16 @@ The recommended way to install the latest release is to use pip:
5454
pip install manim-slides
5555
```
5656

57+
Optionally, you can also install Manim or ManimGL using extras[^1]:
58+
59+
```bash
60+
pip install manim-slides[manim] # For Manim
61+
# or
62+
pip install manim-slides[manimgl] # For ManimGL
63+
```
64+
65+
[^1]: NOTE: you still need to have Manim or ManimGL platform-specific dependencies installed on your computer.
66+
5767
### Install From Repository
5868

5969
An alternative way to install Manim Slides is to clone the git repository, and install from there: read the [contributing guide](https://eertmans.be/manim-slides/contributing/workflow.html) to know how.

docs/source/contributing/workflow.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,32 @@ With Poetry, installation becomes straightforward:
3030
poetry install
3131
```
3232

33+
This, however, only installs the minimal set of dependencies to run the package.
34+
35+
If you would like to install Manim or ManimGL, as documented in the [quickstart](../quickstart),
36+
you can use the `--extras` option:
37+
38+
```bash
39+
poetry install --extras manim # For Manim
40+
# or
41+
poetry install --extras manimgl # For ManimGL
42+
```
43+
44+
Additionnally, Manim Slides comes with group dependencies for development purposes:
45+
46+
```bash
47+
poetry install --with dev # For linters and formatters
48+
# or
49+
poetry install --with docs # To build the documentation locally
50+
```
51+
52+
Another group is `test`, but it is only used for
53+
[GitHub actions](https://github.com/jeertmans/manim-slides/blob/main/.github/workflows/test_examples.yml).
54+
55+
:::{note}
56+
You can combine any number of groups or extras when installing the package locally.
57+
:::
58+
3359
## Running commands
3460

3561
As modules were installed in a new Python environment, you cannot use them directly in the shell.

0 commit comments

Comments
 (0)