From 3dcd1cf8f5f37195d8f2c3c27965c2f97b6a3617 Mon Sep 17 00:00:00 2001 From: Ilan Schnell Date: Sun, 19 Aug 2012 17:57:29 -0500 Subject: [PATCH] add note about running tests --- README.md | 24 ------------------------ README.rst | 39 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 39 insertions(+), 24 deletions(-) delete mode 100644 README.md create mode 100644 README.rst diff --git a/README.md b/README.md deleted file mode 100644 index f0d1f09..0000000 --- a/README.md +++ /dev/null @@ -1,24 +0,0 @@ -# llvm-py: Python Bindings for LLVM # -llvm-py provides Python bindings for LLVM. - -## Home page ## -http://www.llvmpy.org - -## Versions ## -This package has only been tested with LLVM 3.1, and Python 2.7, (not Python 3.x). - -## Quickstart ## -1. Get 3.1 version of LLVM, build it. Make sure '--enable-pic' is passed to LLVM's 'configure'. -2. Get llvm-py and install it: - -``` -$ git clone git@github.com:llvmpy/llvmpy.git -$ cd llvmpy -$ python setup.py install -``` - -3. See documentation at 'http://www.llvmpy.org/pages.html' and examples under 'test'. - -## LICENSE ## -llvm-py is distributed under the new BSD license, which is similar to the LLVM license itself. -See the file called LICENSE for the full license text. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..da506c7 --- /dev/null +++ b/README.rst @@ -0,0 +1,39 @@ +================================= +llvm-py: Python bindings for LLVM +================================= + +Home page +--------- + +http://www.llvmpy.org + +Versions +-------- + +This package has only been tested with LLVM 3.1, and Python 2.7, (not Python 3.x). + +Quickstart +---------- + +1. Get 3.1 version of LLVM, build it. Make sure ``--enable-pic`` is passed to + LLVM's ``configure``. + +2. Get llvm-py and install it:: + + $ git clone git@github.com:llvmpy/llvmpy.git + $ cd llvmpy + $ python setup.py install + + Run the tests:: + + $ python -c "import llvm; llvm.test()" + +3. See documentation at 'http://www.llvmpy.org/pages.html' and examples + under 'test'. + +LICENSE +------- + +llvmpy is distributed under the new BSD license, which is similar to the LLVM +license itself. +See the file called LICENSE for the full license text.