Add docs for everything

[douglascamata]

Please, can you add some docs to the whole project? I want to use it along with grammar to build a compiler in my course at college and it's so hard to figure out how to do stuff without documentation.

[jvoorhis]

Contributions welcome!

My strategy, thus far, has been to provide a rubyish interface to the LLVM C api and appeal to the LLVM docs whenever possible. You can learn a lot from the excellent LLVM docs at http://llvm.org/releases/3.0/docs/index.html. If you build the YARD documentation, you can find a cross-reference for opcodes in the LLVM::Builder documentation, and for passes in the LLVM::PassManager documentation.

That said, I admit the project requires a lot of context before it's easy to use. I'm happy to answer questions on the Ruby-LLVM Google Group at http://groups.google.com/group/ruby-llvm.