diff --git a/README.md b/README.md index 667e8ce6d18e521470939421b2b90f34f5aeda71..5e8d2e17feb77f20eba3dcf9ba6b354f6acac36e 100644 --- a/README.md +++ b/README.md @@ -11,21 +11,45 @@ provided .puml file. - ffmpeg, https://ffmpeg.org/download.html - graphviz, https://graphviz.org/download -- (Windows only) Microsoft Visual C++ 14.0 or newer +- (Windows only) Microsoft Visual C++ 14.0 or newer and Windows + SDK (https://visualstudio.microsoft.com/visual-cpp-build-tools/ under Desktop development with C++) + +All requirements for Linux can be installed using: + +```bash +sudo apt -y install python3-venv python3-dev pkg-config build-essential libpango1.0-dev graphviz libgraphviz-dev ffmpeg +``` + +If there are any problems you can also refer to Manim install +guide (https://docs.manim.community/en/stable/installation.html) ## Installation Before installation, make sure ffmpeg and graphviz are included in PATH. +All commands should be run in package root (where pyproject.toml is). -Run in package root (where pyproject.toml is): +Virtual environment in Linux: +```bash +python3 -m venv pyplaml_venv +source pyplaml_venv/bin/activate +``` + +Virtual environment in Windows: + +```commandline +python3 -m venv pyplaml_venv +.\pyplaml_venv\Scripts\activate +``` + +Install required Python packages: ``` pip install . ``` ### Fix for Windows Graphviz "Failed building wheel" error -``` +```bash python -m pip install --use-pep517 ` --config-settings="--global-option=build_ext" ` --config-settings="--global-option=-IC:\Program Files\Graphviz\include" ` @@ -43,8 +67,6 @@ manim examples/scenes/animals.py -pql ## Example -<p align="center"> - <img src="https://gitlab.vsb.cz/tomas.orvisky.st/pyplaml/-/blob/main/examples/gif/animals.gif"> -</p> + Other examples available at https://gitlab.vsb.cz/tomas.orvisky.st/pyplaml/-/tree/main/examples/gif \ No newline at end of file