| Author | Mac Malone |
|---|---|
| Copyright | Copyright (c) 2012 Mac Malone |
| License | BSD 3-clause (see {file:LICENSE}) |
This project aims to make a simple, clean interface on top of ruby-llvm to make it easier for one to write ruby-llvm programs and libraries. It is also very well documented, if I do say so myself.
ruby-llvm-script has been tested on OS X 10.7 using the following Ruby interpreters:
- MRI 1.8.7-p357
- MRI 1.9.3-p194
- Make sure everything works.
- Requests appreciated.
| Notice | ruby-llvm-script is currently not released as a gem (will be soon). You will, for now, have to install it from the source if you wish to use it. |
|---|
If you would like to see what ruby-llvm-script feels like before getting started, take a look at the Hello World program. Otherwise, you will need to install LLVM and ruby-llvm-script first. After you are done with that, you might wish to take a look at the breakdowns of the example programs in the samples directory:
- Hello World: hello.rb
- Factorial: factorial.rb
- I/O: io.rb
- Conditionals: cond.rb
- Function Pointers: fp.rb
It is advised to look at them in the above order because as each builds upon the last.
The ruby-llvm-script API documentation, generated by YARD can be found here. Also, a bleeding-edge version created from the github repository can at RubyDoc.info: http://www.rubydoc.info/github/tophat/ruby-llvm-script.
You might want to look at the ruby-llvm documentation at http://jvoorhis.com/ruby-llvm and the LLVM assembly language reference at http://llvm.org/docs/LangRef.html if you want to get in real deep.