chore(docs): warn users about #314 (#319)

* chore(docs): warn users about #314 Closes #316 * chore(lint): apply suggested changes
jeertmans · Nov 21, 2023 · 2b25b6a · 2b25b6a
1 parent fc59453
commit 2b25b6a
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -51,6 +51,11 @@ If none of those packages are installed, please refer to their specific installa
 - [Manim](https://docs.manim.community/en/stable/installation.html)
 - [ManimGL](https://3b1b.github.io/manim/getting_started/installation.html)
 
+> **NOTE**: if you install Manim from its git repository, as suggested by ManimGL,
+  make sure to first check out a supported version (e.g., `git checkout tags/v1.6.1`
+  for ManimGL), otherwise it might install an unsupported version of Manim!
+  See [#314](https://github.com/jeertmans/manim-slides/issues/314) for an example.
+
 <!-- end deps -->
 
 ### Pip Install