support HTML coverage reports
[cython.git] / README.txt
index 371fa2396aadb928c6a8682b95dc77eb8e3861ce..8c0275803c59785edea0e402e63e3f415e28f89b 100644 (file)
@@ -1,31 +1,41 @@
 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.
+
+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.
+
+This makes Cython the ideal language for wrapping external C libraries, and
+for fast C modules that speed up the execution of Python code.
 
 LICENSE:
 
 The original Pyrex program was licensed "free of restrictions" (see
-below).  Cython itself is licensed under the 
+below).  Cython itself is licensed under the permissive
 
-   PYTHON SOFTWARE FOUNDATION LICENSE
-   http://www.python.org/psf/license/
+   Apache License
 
+See LICENSE.txt.
 
 
 --------------------------
 
-Note that Cython no longer ships the Mercurial (hg) repository in its
-source distribution.  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
+Note that Cython used to ship the full version control repository in its source
+distribution, but no longer does so due to space constraints.  To get the
+full source history, make sure you have git installed, then step into the
+base directory of the Cython source distribution and type
 
     make repo
 
 Alternatively, check out the latest developer repository from
 
-    http://hg.cython.org/cython-devel
+    https://github.com/cython/cython