diff options
| author | Stefan van der Walt <stefan@sun.ac.za> | 2008-08-23 23:17:23 +0000 |
|---|---|---|
| committer | Stefan van der Walt <stefan@sun.ac.za> | 2008-08-23 23:17:23 +0000 |
| commit | 5c86844c34674e3d580ac2cd12ef171e18130b13 (patch) | |
| tree | 2fdf1150706c07c7e193eb7483ce58a5074e5774 /doc/cython/README.txt | |
| parent | 376d483d31c4c5427510cf3a8c69fc795aef63aa (diff) | |
| download | numpy-5c86844c34674e3d580ac2cd12ef171e18130b13.tar.gz | |
Move documentation outside of source tree. Remove `doc` import from __init__.
Diffstat (limited to 'doc/cython/README.txt')
| -rw-r--r-- | doc/cython/README.txt | 20 |
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 |