From 6eed5af4c3f14397e1ceda727dcfec1cbf0da138 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tom=C3=A1=C5=A1=20Orvisk=C3=BD?= <orvisky.tomas@centrum.cz>
Date: Sun, 28 Apr 2024 18:56:01 +0200
Subject: [PATCH] readme update

---
 README.md | 34 ++++++++++++++++++++++++++++------
 1 file changed, 28 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 667e8ce..5e8d2e1 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>
+![](https://gitlab.vsb.cz/tomas.orvisky.st/pyplaml/-/blob/main/examples/gif/animals.gif)
 
 Other examples available at https://gitlab.vsb.cz/tomas.orvisky.st/pyplaml/-/tree/main/examples/gif
\ No newline at end of file
-- 
GitLab