From 3b17dee61e53615a6070ab91011a39ecd9da1f56 Mon Sep 17 00:00:00 2001
From: Nat Quayle Nelson <natquaylenelson@gmail.com>
Date: Wed, 29 Mar 2023 06:33:57 -0600
Subject: [PATCH] hollywoo README with type param guide

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..105dd75
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# hollywoo
+Portable interface for kinetic novel dev/animated filmmaking
+
+## Principles
+
+TODO explain Director
+
+## Maintenance
+
+### How to add a type to Director:
+
+You must add the type parameter in many places:
+
+* Movie.hx (on class Movie)
+* Movie.kiss (on prop director)
+* Scene.hx (on typedef Scene) (if scenes will contain it)
+* Director.hx (on class Director AND field movie)
+* YourMovieType.hx, YourMovieType.kiss and YourDirectorType.hx, YourDirectorType.kiss in your Hollywoo director implementation
\ No newline at end of file