From 0bd4a8c8412516d68a84abfbf71fb4b536df8c16 Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner <inform@tiker.net> Date: Sun, 16 Dec 2012 13:29:07 -0500 Subject: [PATCH] Move long description to README.rst, so that github can find it. --- README | 9 --------- README.rst | 34 ++++++++++++++++++++++++++++++++++ setup.py | 36 +----------------------------------- 3 files changed, 35 insertions(+), 44 deletions(-) delete mode 100644 README create mode 100644 README.rst diff --git a/README b/README deleted file mode 100644 index 947a93c9..00000000 --- a/README +++ /dev/null @@ -1,9 +0,0 @@ -Hi there, welcome to PyOpenCL! ----------------------------- - -You can find installation instructions and documentation at - - http://mathema.tician.de/software/pyopencl - -Have fun, -Andreas diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..15c19a61 --- /dev/null +++ b/README.rst @@ -0,0 +1,34 @@ +PyOpenCL lets you access GPUs and other massively parallel compute +devices from Python. It tries to offer computing goodness in the +spirit of its sister project `PyCUDA <http://mathema.tician.de/software/pycuda>`_: + +* Object cleanup tied to lifetime of objects. This idiom, often + called + `RAII <http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization>`_ + in C++, makes it much easier to write correct, leak- and + crash-free code. + +* Completeness. PyOpenCL puts the full power of OpenCL's API at + your disposal, if you wish. Every obscure `get_info()` query and + all CL calls are accessible. + +* Automatic Error Checking. All CL errors are automatically + translated into Python exceptions. + +* Speed. PyOpenCL's base layer is written in C++, so all the niceties + above are virtually free. + +* Helpful and complete `Documentation <http://documen.tician.de/pyopencl>`_ + as well as a `Wiki <http://wiki.tiker.net/PyOpenCL>`_. + +* Liberal license. PyOpenCL is open-source under the + `MIT license <http://en.wikipedia.org/wiki/MIT_License>`_ + and free for commercial, academic, and private use. + +* Broad support. PyOpenCL was tested and works with Apple's, AMD's, and Nvidia's + CL implementations. + +Like PyOpenCL? (And perhaps use it for `bitcoin +<http://bitcoin.org>`_ mining?) Leave a (bitcoin) tip: +1HGPQitv27CdENBcH1bstu5B3zeqXRDwtY + diff --git a/setup.py b/setup.py index 032f692c..02317341 100644 --- a/setup.py +++ b/setup.py @@ -163,41 +163,7 @@ def main(): # metadata version=ver_dic["VERSION_TEXT"], description="Python wrapper for OpenCL", - long_description=""" - PyOpenCL lets you access GPUs and other massively parallel compute - devices from Python. It tries to offer computing goodness in the - spirit of its sister project `PyCUDA <http://mathema.tician.de/software/pycuda>`_: - - * Object cleanup tied to lifetime of objects. This idiom, often - called - `RAII <http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization>`_ - in C++, makes it much easier to write correct, leak- and - crash-free code. - - * Completeness. PyOpenCL puts the full power of OpenCL's API at - your disposal, if you wish. Every obscure `get_info()` query and - all CL calls are accessible. - - * Automatic Error Checking. All CL errors are automatically - translated into Python exceptions. - - * Speed. PyOpenCL's base layer is written in C++, so all the niceties - above are virtually free. - - * Helpful and complete `Documentation <http://documen.tician.de/pyopencl>`_ - as well as a `Wiki <http://wiki.tiker.net/PyOpenCL>`_. - - * Liberal license. PyOpenCL is open-source under the - `MIT license <http://en.wikipedia.org/wiki/MIT_License>`_ - and free for commercial, academic, and private use. - - * Broad support. PyOpenCL was tested and works with Apple's, AMD's, and Nvidia's - CL implementations. - - Like PyOpenCL? (And perhaps use it for `bitcoin - <http://bitcoin.org>`_ mining?) Leave a (bitcoin) tip: - 1HGPQitv27CdENBcH1bstu5B3zeqXRDwtY - """, + long_description=open("README.rst", "rt").read(), author="Andreas Kloeckner", author_email="inform@tiker.net", license = "MIT", -- GitLab