Merge https://github.com/snaury/cython
[cython.git] / README.txt
index 4a70f7c2d5602302a3a93364b53ffb668f8e7722..e6b10e79ebd1e87780b1d2f393758aaac7246ca9 100644 (file)
@@ -1,32 +1,42 @@
 Welcome to Cython!
 =================
 
-Cython (http://www.cython.org) is based on Pyrex, but 
-supports more cutting edge functionality and optimizations.
+Cython (http://cython.org) is a language that makes writing C extensions for
+the Python language as easy as Python itself.  Cython is based on the
+well-known Pyrex, but supports more cutting edge functionality and
+optimizations.
 
-LICENSE:
+The Cython language is very close to the Python language, but Cython
+additionally supports calling C functions and declaring C types on variables
+and class attributes.  This allows the compiler to generate very efficient C
+code from Cython code.
 
-The original Pyrex program was licensed "free of restrictions" (see
-below).  Cython itself is licensed under the 
+This makes Cython the ideal language for wrapping external C libraries, and
+for fast C modules that speed up the execution of Python code.
 
-   PYTHON SOFTWARE FOUNDATION LICENSE
-   http://www.python.org/psf/license/
+LICENSE:
 
+The original Pyrex program was licensed "free of restrictions" (see
+below).  Cython itself is licensed under the permissive
 
+   Apache License
 
+See LICENSE.txt.
 
 
 --------------------------
 
-To see the change history, go to the Pyrex directory and type 
+Note that Cython used to ship the Mercurial (hg) repository in its source
+distribution, but no longer does so due to space constraints.  To get the
+full source history, make sure you have hg installed, then step into the
+base directory of the Cython source distribution and type
 
- $ hg log
+    make repo
 
-This requires that you have installed Mercurial.
+Alternatively, check out the latest developer repository from
 
- -- William Stein (wstein@gmail.com)
+    http://hg.cython.org/cython-devel
 
-xxxx
 
 
 The following is from Pyrex: