Skip to content
Snippets Groups Projects
Commit 6eed5af4 authored by Tomáš Orviský's avatar Tomáš Orviský
Browse files

readme update

parent f70ad621
No related merge requests found
...@@ -11,21 +11,45 @@ provided .puml file. ...@@ -11,21 +11,45 @@ provided .puml file.
- ffmpeg, https://ffmpeg.org/download.html - ffmpeg, https://ffmpeg.org/download.html
- graphviz, https://graphviz.org/download - 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 ## Installation
Before installation, make sure ffmpeg and graphviz are included in PATH. 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 . pip install .
``` ```
### Fix for Windows Graphviz "Failed building wheel" error ### Fix for Windows Graphviz "Failed building wheel" error
``` ```bash
python -m pip install --use-pep517 ` python -m pip install --use-pep517 `
--config-settings="--global-option=build_ext" ` --config-settings="--global-option=build_ext" `
--config-settings="--global-option=-IC:\Program Files\Graphviz\include" ` --config-settings="--global-option=-IC:\Program Files\Graphviz\include" `
...@@ -43,8 +67,6 @@ manim examples/scenes/animals.py -pql ...@@ -43,8 +67,6 @@ manim examples/scenes/animals.py -pql
## Example ## Example
<p align="center"> ![](https://gitlab.vsb.cz/tomas.orvisky.st/pyplaml/-/blob/main/examples/gif/animals.gif)
<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 Other examples available at https://gitlab.vsb.cz/tomas.orvisky.st/pyplaml/-/tree/main/examples/gif
\ No newline at end of file
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment