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

chore(docs): update install documentation #175

Merged
merged 3 commits into from
May 7, 2023
Merged
Show file tree
Hide file tree
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
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,16 @@ The recommended way to install the latest release is to use pip:
pip install manim-slides
```

Optionally, you can also install Manim or ManimGL using extras[^1]:

```bash
pip install manim-slides[manim] # For Manim
# or
pip install manim-slides[manimgl] # For ManimGL
```

[^1]: NOTE: you still need to have Manim or ManimGL platform-specific dependencies installed on your computer.

### Install From Repository

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.
Expand Down
26 changes: 26 additions & 0 deletions docs/source/contributing/workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,32 @@ With Poetry, installation becomes straightforward:
poetry install
```

This, however, only installs the minimal set of dependencies to run the package.

If you would like to install Manim or ManimGL, as documented in the [quickstart](../quickstart),
you can use the `--extras` option:

```bash
poetry install --extras manim # For Manim
# or
poetry install --extras manimgl # For ManimGL
```

Additionnally, Manim Slides comes with group dependencies for development purposes:

```bash
poetry install --with dev # For linters and formatters
# or
poetry install --with docs # To build the documentation locally
```

Another group is `test`, but it is only used for
[GitHub actions](https://github.com/jeertmans/manim-slides/blob/main/.github/workflows/test_examples.yml).

:::{note}
You can combine any number of groups or extras when installing the package locally.
:::

## Running commands

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