More README updating, switched to markdown format

This commit is contained in:
AndrewBC 2011-06-07 13:54:56 -05:00
commit 186d2f0ac0

36
README.md Normal file
View file

@ -0,0 +1,36 @@
llvm-py: Python Bindings for LLVM
=================================
llvm-py provides Python bindings for LLVM.
Home page:
----------
https://github.com/AndrewBC/llvm-py
Versions:
---------
This package has only been tested with LLVM 2.9, and Python 2.7,
(not Python 3.x).
Quickstart:
-----------
1. Get 2.9 version of LLVM, build it. Make sure '--enable-pic' is
passed to LLVM's 'configure'.
2. Get llvm-py and install it:
- To get from SVN:
$ git clone git@github.com:AndrewBC/llvm-py.git
- To build and install:
$ cd llvm-py
$ python setup.py install
3. See documentation at 'www/web/index.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.