Commit b15eb2aa authored by gabrieldemarmiesse's avatar gabrieldemarmiesse

Made the readme pretty for github.

parent 831ce22f
Welcome to Cython! Welcome to Cython!
================= =================
Cython (http://cython.org) is a language that makes writing C extensions for Cython is a language that makes writing C extensions for
the Python language as easy as Python itself. Cython is based on the the Python language as easy as Python itself. Cython is based on the
well-known Pyrex, but supports more cutting edge functionality and well-known Pyrex, but supports more cutting edge functionality and
optimizations. optimizations.
The Cython language is very close to the Python language, but Cython The Cython language is very close to the Python language, but Cython
additionally supports calling C functions and declaring C types on variables additionally supports calling C functions and declaring C types on variables
and class attributes. This allows the compiler to generate very efficient C and class attributes. This allows the compiler to generate very efficient C
code from Cython code. code from Cython code.
This makes Cython the ideal language for wrapping external C libraries, and This makes Cython the ideal language for wrapping external C libraries, and
for fast C modules that speed up the execution of Python code. for fast C modules that speed up the execution of Python code.
LICENSE: - Official website: http://cython.org/
- Documentation: http://docs.cython.org/en/latest/
The original Pyrex program was licensed "free of restrictions" (see - Github repository: https://github.com/cython/cython
below). Cython itself is licensed under the permissive - Wiki: https://github.com/cython/cython/wiki
Apache License
### Installation:
See LICENSE.txt.
If you already have a C compiler, just do
```sh
-------------------------- pip install Cython
```
Note that Cython used to ship the full version control repository in its source otherwise, see [the installation page](http://docs.cython.org/en/latest/src/quickstart/install.html).
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 ### LICENSE:
make repo The original Pyrex program was licensed "free of restrictions" (see below).
Cython itself is licensed under the permissive Apache License.
Alternatively, check out the latest developer repository from
See [LICENSE.txt](https://github.com/cython/cython/blob/master/LICENSE.txt).
https://github.com/cython/cython
### Get the full source history:
The following is from Pyrex: 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
```sh
make repo
```
The following is from Pyrex:
------------------------------------------------------ ------------------------------------------------------
This is a development version of Pyrex, a language This is a development version of Pyrex, a language
for writing Python extension modules. for writing Python extension modules.
For more info, see: For more info, see:
Doc/About.html for a description of the language Doc/About.html for a description of the language
INSTALL.txt for installation instructions INSTALL.txt for installation instructions
USAGE.txt for usage instructions USAGE.txt for usage instructions
Demos for usage examples Demos for usage examples
Comments, suggestions, bug reports, etc. are Comments, suggestions, bug reports, etc. are
welcome! welcome!
Copyright stuff: Pyrex is free of restrictions. You Copyright stuff: Pyrex is free of restrictions. You
may use, redistribute, modify and distribute modified may use, redistribute, modify and distribute modified
versions. versions.
The latest version of Pyrex can be found here: The latest version of Pyrex can be found [here](http://www.cosc.canterbury.ac.nz/~greg/python/Pyrex/).
http://www.cosc.canterbury.ac.nz/~greg/python/Pyrex/ Greg Ewing, Computer Science Dept,
University of Canterbury,
Greg Ewing, Computer Science Dept, +--------------------------------------+ Christchurch, New Zealand
University of Canterbury, | A citizen of NewZealandCorp, a | greg@cosc.canterbury.ac.nz
Christchurch, New Zealand | wholly-owned subsidiary of USA Inc. |
greg@cosc.canterbury.ac.nz +--------------------------------------+ >A citizen of NewZealandCorp, a wholly-owned subsidiary of USA Inc.
\ No newline at end of file
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment