From d1d9cf92639941dc6d12dbfd4a226d7b4ec6a434 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tom=C3=A1=C5=A1=20Orvisk=C3=BD?= <orvisky.tomas@centrum.cz>
Date: Sat, 3 Feb 2024 13:03:06 +0100
Subject: [PATCH] added readme

---
 README.md | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..54bd845
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+# PyPLAML
+
+An extension for Manim (https://www.manim.community/) supporting class diagrams. Allows creating various types
+of classes (interfaces,
+enums, ...) and relations between them, which can be later animated using Manim interface.
+
+There is also a parser for PlantUML (https://plantuml.com/class-diagram), which can automatically create a diagram from
+provided .puml file.
+
+## Requirements
+
+- ffmpeg, https://ffmpeg.org/download.html
+- graphviz, https://graphviz.org/download
+- (Windows only) Microsoft Visual C++ 14.0 or newer
+
+## Installation
+
+Before installation, make sure ffmpeg and graphviz are included in PATH.
+
+Run in package root (where pyproject.toml is):
+
+```
+pip install .
+```
+
+### Fix for Windows Graphviz "Failed building wheel" error
+
+```
+python -m pip install --use-pep517 `
+              --config-settings="--global-option=build_ext" `
+              --config-settings="--global-option=-IC:\Program Files\Graphviz\include" `
+              --config-settings="--global-option=-LC:\Program Files\Graphviz\lib" `
+              pygraphviz
+```
+
+## Usage
+
+Usage is same as running any other manim scene. To run a scene from examples run:
+
+```commandline
+manim examples/scenes/animals.py -pql
+```
\ No newline at end of file
-- 
GitLab