mirror of
https://github.com/jeertmans/manim-slides.git
synced 2025-05-22 04:56:24 +08:00
0ce4c18519
* chore(docs): improving the docs This improves the docs as suggested by some reddit user. Now, most of Manim is documented in one place * try: update lockfile * chore(deps): remove duplicate key * fix(ci): isort issue See https://github.com/home-assistant/core/issues/86892 * fix(ci): bad identation * fix(ci): fixing lock file * fix(example): issue when ManimGL does not count wait as animation
58 lines
1.9 KiB
Markdown
58 lines
1.9 KiB
Markdown
# Workflow
|
|
|
|
This document is there to help you recreate a working environment for Manim Slides.
|
|
|
|
## Dependencies
|
|
|
|
```{include} ../../../README.md
|
|
:start-after: <!-- start deps -->
|
|
:end-before: <!-- end deps -->
|
|
```
|
|
|
|
## Forking the repository and cloning it locally
|
|
|
|
We used GitHub to host Manim Slides' repository, and we encourage contributors to use git.
|
|
|
|
Useful links:
|
|
|
|
* [GitHub's Hello World](https://docs.github.com/en/get-started/quickstart/hello-world).
|
|
* [GitHub Pull Request in 100 Seconds](https://www.youtube.com/watch?v=8lGpZkjnkt4&ab_channel=Fireship).
|
|
|
|
Once you feel comfortable with git and GitHub, [fork](https://github.com/jeertmans/manim-slides/fork) the repository, and clone it locally.
|
|
|
|
As for every Python project, using virtual environment is recommended to avoid conflicts between modules. For Manim Slides, we use [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer). If not already, please install it.
|
|
|
|
## Installing Python modules
|
|
|
|
With Poetry, installation becomes straightforward:
|
|
|
|
```bash
|
|
poetry install
|
|
```
|
|
|
|
## Running commands
|
|
|
|
As modules were installed in a new Python environment, you cannot use them directly in the shell.
|
|
Instead, you either need to prepend `poetry run` to any command, e.g.:
|
|
|
|
```bash
|
|
poetry run manim-slides wizard
|
|
```
|
|
|
|
or enter a new shell that uses this new Python environment:
|
|
|
|
```
|
|
poetry run
|
|
manim-slides wizard
|
|
```
|
|
|
|
## Testing your code
|
|
|
|
Most of the tests are done with GitHub actions, thus not on your computer. The only command you should run locally is `pre-commit run --all-files`: this runs a few linter and formatter to make sure the code quality and style stay constant across time. If a warning or an error is displayed, please fix it before going to next step.
|
|
|
|
## Proposing changes
|
|
|
|
Once you feel ready and think your contribution is ready to be reviewed, create a [pull request](https://github.com/jeertmans/manim-slides/pulls) and wait for a reviewer to check your work!
|
|
|
|
Many thanks to you!
|