merged in Vitja's tab removals
[cython.git] / README.txt
1 Welcome to Cython!
2 =================
3
4 Cython (http://cython.org) is a language that makes writing C extensions for
5 the Python language as easy as Python itself.  Cython is based on the
6 well-known Pyrex, but supports more cutting edge functionality and
7 optimizations.
8
9 The Cython language is very close to the Python language, but Cython
10 additionally supports calling C functions and declaring C types on variables
11 and class attributes.  This allows the compiler to generate very efficient C
12 code from Cython code.
13
14 This makes Cython the ideal language for wrapping external C libraries, and
15 for fast C modules that speed up the execution of Python code.
16
17 LICENSE:
18
19 The original Pyrex program was licensed "free of restrictions" (see
20 below).  Cython itself is licensed under the permissive
21
22    Apache License
23
24 See LICENSE.txt.
25
26
27 --------------------------
28
29 Note that Cython used to ship the full version control repository in its source
30 distribution, but no longer does so due to space constraints.  To get the
31 full source history, make sure you have git installed, then step into the
32 base directory of the Cython source distribution and type
33
34     make repo
35
36 Alternatively, check out the latest developer repository from
37
38     https://github.com/cython/cython
39
40
41
42 The following is from Pyrex:
43 ------------------------------------------------------
44 This is a development version of Pyrex, a language
45 for writing Python extension modules.
46
47 For more info, see:
48
49     Doc/About.html for a description of the language
50     INSTALL.txt    for installation instructions
51     USAGE.txt      for usage instructions
52     Demos          for usage examples
53
54 Comments, suggestions, bug reports, etc. are
55 welcome!
56
57 Copyright stuff: Pyrex is free of restrictions. You
58 may use, redistribute, modify and distribute modified
59 versions.
60
61 The latest version of Pyrex can be found here:
62
63 http://www.cosc.canterbury.ac.nz/~greg/python/Pyrex/
64
65 Greg Ewing, Computer Science Dept, +--------------------------------------+
66 University of Canterbury,          | A citizen of NewZealandCorp, a       |
67 Christchurch, New Zealand          | wholly-owned subsidiary of USA Inc.  |
68 greg@cosc.canterbury.ac.nz         +--------------------------------------+