Blame README.rst

Packit 562c7a
Welcome to Cython!  
Packit 562c7a
==================
Packit 562c7a
Packit 562c7a
Cython is a language that makes writing C extensions for
Packit 562c7a
the Python language as easy as Python itself.  Cython is based on the
Packit 562c7a
well-known Pyrex, but supports more cutting edge functionality and
Packit 562c7a
optimizations.
Packit 562c7a
Packit 562c7a
The Cython language is very close to the Python language, but Cython
Packit 562c7a
additionally supports calling C functions and declaring C types on variables
Packit 562c7a
and class attributes.  This allows the compiler to generate very efficient C
Packit 562c7a
code from Cython code.
Packit 562c7a
Packit 562c7a
This makes Cython the ideal language for wrapping external C libraries, and
Packit 562c7a
for fast C modules that speed up the execution of Python code.
Packit 562c7a
Packit 562c7a
* Official website: http://cython.org/
Packit 562c7a
* Documentation: http://docs.cython.org/en/latest/
Packit 562c7a
* Github repository: https://github.com/cython/cython
Packit 562c7a
* Wiki: https://github.com/cython/cython/wiki
Packit 562c7a
Packit 562c7a
Packit 562c7a
Installation:
Packit 562c7a
-------------
Packit 562c7a
Packit 562c7a
If you already have a C compiler, just do::
Packit 562c7a
Packit 562c7a
   pip install Cython
Packit 562c7a
Packit 562c7a
otherwise, see `the installation page <http://docs.cython.org/en/latest/src/quickstart/install.html>`_.
Packit 562c7a
Packit 562c7a
Packit 562c7a
LICENSE:
Packit 562c7a
--------
Packit 562c7a
Packit 562c7a
The original Pyrex program was licensed "free of restrictions" (see below).
Packit 562c7a
Cython itself is licensed under the permissive **Apache License**.
Packit 562c7a
Packit 562c7a
See `LICENSE.txt <https://github.com/cython/cython/blob/master/LICENSE.txt>`_.
Packit 562c7a
Packit 562c7a
Packit 562c7a
Get the full source history:
Packit 562c7a
----------------------------
Packit 562c7a
Packit 562c7a
Note that Cython used to ship the full version control repository in its source
Packit 562c7a
distribution, but no longer does so due to space constraints.  To get the
Packit 562c7a
full source history, make sure you have git installed, then step into the
Packit 562c7a
base directory of the Cython source distribution and type::
Packit 562c7a
Packit 562c7a
    make repo
Packit 562c7a
Packit 562c7a
Packit 562c7a
The following is from Pyrex:
Packit 562c7a
------------------------------------------------------
Packit 562c7a
This is a development version of Pyrex, a language
Packit 562c7a
for writing Python extension modules.
Packit 562c7a
Packit 562c7a
For more info, see:
Packit 562c7a
Packit 562c7a
* Doc/About.html for a description of the language
Packit 562c7a
* INSTALL.txt    for installation instructions
Packit 562c7a
* USAGE.txt      for usage instructions
Packit 562c7a
* Demos          for usage examples
Packit 562c7a
Packit 562c7a
Comments, suggestions, bug reports, etc. are
Packit 562c7a
welcome!
Packit 562c7a
Packit 562c7a
Copyright stuff: Pyrex is free of restrictions. You
Packit 562c7a
may use, redistribute, modify and distribute modified
Packit 562c7a
versions.
Packit 562c7a
Packit 562c7a
The latest version of Pyrex can be found `here <http://www.cosc.canterbury.ac.nz/~greg/python/Pyrex/>`_.
Packit 562c7a
Packit 562c7a
| Greg Ewing, Computer Science Dept
Packit 562c7a
| University of Canterbury
Packit 562c7a
| Christchurch, New Zealand
Packit 562c7a
Packit 562c7a
 A citizen of NewZealandCorp, a wholly-owned subsidiary of USA Inc.