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.
...@@ -14,30 +14,38 @@ code from Cython code. ...@@ -14,30 +14,38 @@ 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/
- Github repository: https://github.com/cython/cython
- Wiki: https://github.com/cython/cython/wiki
The original Pyrex program was licensed "free of restrictions" (see
below). Cython itself is licensed under the permissive
Apache License ### Installation:
See LICENSE.txt. If you already have a C compiler, just do
```sh
pip install Cython
```
otherwise, see [the installation page](http://docs.cython.org/en/latest/src/quickstart/install.html).
-------------------------- ### LICENSE:
The original Pyrex program was licensed "free of restrictions" (see below).
Cython itself is licensed under the permissive Apache License.
See [LICENSE.txt](https://github.com/cython/cython/blob/master/LICENSE.txt).
### Get the full source history:
Note that Cython used to ship the full version control repository in its source 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 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 full source history, make sure you have git installed, then step into the
base directory of the Cython source distribution and type base directory of the Cython source distribution and type
```sh
make repo make repo
```
Alternatively, check out the latest developer repository from
https://github.com/cython/cython
The following is from Pyrex: The following is from Pyrex:
------------------------------------------------------ ------------------------------------------------------
...@@ -58,11 +66,11 @@ Copyright stuff: Pyrex is free of restrictions. You ...@@ -58,11 +66,11 @@ 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,
Christchurch, New Zealand
greg@cosc.canterbury.ac.nz
Greg Ewing, Computer Science Dept, +--------------------------------------+ >A citizen of NewZealandCorp, a wholly-owned subsidiary of USA Inc.
University of Canterbury, | A citizen of NewZealandCorp, a | \ No newline at end of file
Christchurch, New Zealand | wholly-owned subsidiary of USA Inc. |
greg@cosc.canterbury.ac.nz +--------------------------------------+
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