[Bf-extensions-cvs] SVN commit: /data/svn/bf-extensions [1214] trunk/py/scripts/addons/rigify/ README: Update to the Rigify readme, so explain how to have a rig type generate a

[Nathan Vegdahl]

Revision: 1214
          http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-extensions&revision=1214
Author:   cessen
Date:     2010-12-02 03:15:59 +0100 (Thu, 02 Dec 2010)

Log Message:
-----------
Update to the Rigify readme, so explain how to have a rig type generate a
python UI for the generated rig.

Modified Paths:
--------------
    trunk/py/scripts/addons/rigify/README

Modified: trunk/py/scripts/addons/rigify/README
===================================================================
--- trunk/py/scripts/addons/rigify/README	2010-12-02 01:52:04 UTC (rev 1213)
+++ trunk/py/scripts/addons/rigify/README	2010-12-02 02:15:59 UTC (rev 1214)
@@ -236,3 +236,17 @@
 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.
+