Fleshed out README a bit more
Inkwell aims to help you pen your own programming languages by safely wrapping llvm-sys. It provides a more strongly typed interface than LLVM itself so that certain types of errors can be caught at compile time instead of at LLVM's runtime. The ultimate goal is to make LLVM safer from the rust end and a bit easier to use. Inkwell currently compiles on stable, though this may be subject to change in the future.
-# Example
+# Documentation
-Here's [tari's llvm-sys example](https://bitbucket.org/tari/llvm-sys.rs/src/ea4ac92a171da2c1851806b91e531ed3a0b41091/examples/jit-function.rs?fileviewer=file-view-default) written completely in safe code with Inkwell<sup>1</sup>:
+## Example
+
+Here's [tari's llvm-sys example](https://bitbucket.org/tari/llvm-sys.rs/src/ea4ac92a171da2c1851806b91e531ed3a0b41091/examples/jit-function.rs) written in safe code<sup>1</sup> with Inkwell:
```rust
use context::Context;
@@ -45,4 +47,8 @@ Here's [tari's llvm-sys example](https://bitbucket.org/tari/llvm-sys.rs/src/ea4a
assert_eq!(sum(x, y, z), x + y + z);
```
-<sup>1</sup> Casting the LLVM JIT function address into a rust function does require a single unsafe transmute, since inkwell doesn't know what the function signature is. Maybe we can do something about this in the future?
+<sup>1</sup> Casting the LLVM JIT function address into a rust function does require a single unsafe transmute, since Inkwell doesn't know what the function signature is. Maybe we can do something about this in the future? In theory, fn_type does contain all the needed info, so whether or not we can do this automagically depends on what rust is capable of. Converting structs, pointers, and other types could be tricky but might be seen as a form of deserialization. See [#5](https://github.com/TheDan64/inkwell/issues/5) for the tracking issue.
+
+# Building
+
+Inkwell requires LLVM to be installed when building. Currently only LLVM 3.7 is supported, though multi-version support is planned. See [#1](https://github.com/TheDan64/inkwell/issues/1) for the tracking issue.
