From 5c91e15e8a7f4c107928c79de32b9846e1f204bd Mon Sep 17 00:00:00 2001
From: Juergen Stuber <juergen@jstuber.net>
Date: Wed, 15 Oct 2025 23:08:03 +0200
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..882c1be
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# Render a rotating view around a Lorenz attractor
+This visualizes the 3D structure of the attractor.
+
+# Thanks
+This was heavily inspired by this video by Grant Sanderson @3blue1brown:
+[How I animate 3Blue1Brown](https://www.youtube.com/watch?v=rbu7Zu5X1zI)
+
+# Scenes
+
+## `scene.py`
+Renders the state of a single Lorenz system.
+
+## `scene_diverge.py`
+Renders the state of a two Lorenz systems whose initial states
+have a difference of 1/1000th in the z direction.
+Initially they are on top of each other,
+then after some time they diverge and take completely different trajectories.
+
+# Manim installation
+`python -m pip install manim`
+
+This is the community edition of Manim, which differs somewhat
+from the version used in the @3blue1brown video.
+
+# Render a scene
+E.g. `python -m manim -pql scene_diverge.py LorenzAttractor`
+
+## Options
+- `-p`  Play once
+- `-ql`  Low quality (480p, 15fps), use for development.
+- `-qh`  High quality (1080p, 60fps), renders very slowly, 
+         use it to render the final version.
+
+## Outputs
+Can be found in the `media` subdirectory after rendering.