summaryrefslogtreecommitdiffstats
path: root/Tools/framer/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Tools/framer/README.txt')
-rw-r--r--Tools/framer/README.txt8
1 files changed, 8 insertions, 0 deletions
diff --git a/Tools/framer/README.txt b/Tools/framer/README.txt
new file mode 100644
index 0000000..4a93a4d
--- /dev/null
+++ b/Tools/framer/README.txt
@@ -0,0 +1,8 @@
+framer is a tool to generate boilerplate code for C extension types.
+
+The boilerplate is generated from a specification object written in
+Python. The specification uses the class statement to describe the
+extension module and any extension types it contains. From the
+specification, framer can generate all the boilerplate C code,
+including function definitions, argument handling code, and type
+objects.