summaryrefslogtreecommitdiff
path: root/doc/cython/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/cython/README.txt')
-rw-r--r--doc/cython/README.txt20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/cython/README.txt b/doc/cython/README.txt
new file mode 100644
index 000000000..ff0abb0fe
--- /dev/null
+++ b/doc/cython/README.txt
@@ -0,0 +1,20 @@
+==================
+ NumPy and Cython
+==================
+
+This directory contains a small example of how to use NumPy and Cython
+together. While much work is planned for the Summer of 2008 as part of the
+Google Summer of Code project to improve integration between the two, even
+today Cython can be used effectively to write optimized code that accesses
+NumPy arrays.
+
+The example provided is just a stub showing how to build an extension and
+access the array objects; improvements to this to show more sophisticated tasks
+are welcome.
+
+To run it locally, simply type::
+
+ make help
+
+which shows you the currently available targets (these are just handy
+shorthands for common commands). \ No newline at end of file