Commit c3299480 authored by scoder's avatar scoder Committed by GitHub

Merge pull request #2149 from gabrieldemarmiesse/readme

Made the readme pretty for github.
parents 93843b94 85ad9f68
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
well-known Pyrex, but supports more cutting edge functionality and
optimizations.
......@@ -14,30 +14,41 @@ 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:
* 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
Installation:
-------------
If you already have a C compiler, just do::
pip install Cython
otherwise, see `the installation page <http://docs.cython.org/en/latest/src/quickstart/install.html>`_.
The original Pyrex program was licensed "free of restrictions" (see
below). Cython itself is licensed under the permissive
Apache 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.
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
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
base directory of the Cython source distribution and type::
make repo
Alternatively, check out the latest developer repository from
https://github.com/cython/cython
The following is from Pyrex:
------------------------------------------------------
......@@ -46,10 +57,10 @@ for writing Python extension modules.
For more info, see:
Doc/About.html for a description of the language
INSTALL.txt for installation instructions
USAGE.txt for usage instructions
Demos for usage examples
* Doc/About.html for a description of the language
* INSTALL.txt for installation instructions
* USAGE.txt for usage instructions
* Demos for usage examples
Comments, suggestions, bug reports, etc. are
welcome!
......@@ -58,11 +69,13 @@ Copyright stuff: Pyrex is free of restrictions. You
may use, redistribute, modify and distribute modified
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/>`_.
| Greg Ewing, Computer Science Dept
| University of Canterbury
| Christchurch, New Zealand
| greg@cosc.canterbury.ac.nz
|
http://www.cosc.canterbury.ac.nz/~greg/python/Pyrex/
A citizen of NewZealandCorp, a wholly-owned subsidiary of USA Inc.
Greg Ewing, Computer Science Dept, +--------------------------------------+
University of Canterbury, | A citizen of NewZealandCorp, a |
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