From a79931600cc49a7570365afa6bf83ce7ba0404f0 Mon Sep 17 00:00:00 2001
From: Nathan Vegdahl <cessen@cessen.com>
Date: Thu, 2 Dec 2010 02:15:59 +0000
Subject: [PATCH] Update to the Rigify readme, so explain how to have a rig
 type generate a python UI for the generated rig.

---
 rigify/README | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/rigify/README b/rigify/README
index ae26c8066..39e8cda65 100644
--- a/rigify/README
+++ b/rigify/README
@@ -236,3 +236,17 @@ especially with more complex samples.  There is a function in utils.py
 that will generate the code for create_sample() for you, based on a selected
 armature.  The function is called write_metarig()
 
+
+GENERATING A PYTHON UI
+----------------------
+The generate() method can also, optionally, return python code as a string.
+This python code is added to the "rig properties" panel that gets
+auto-generated along with the rig.  This is useful for exposing things like
+IK/FK switches in a nice way to the animator.
+
+The string must be returned in a list:
+
+return ["my python code"]
+
+Otherwise it won't work.
+
-- 
GitLab