Skip to content

Commit

Permalink
Clarified in README that branch usage doesn't require explicit featur…
Browse files Browse the repository at this point in the history
…e use
  • Loading branch information
TheDan64 committed Apr 27, 2018
1 parent 99f3e0a commit 5a6dc48
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,16 @@ You'll need to point your Cargo.toml to a branch and use a feature flag correspo

```toml
[dependencies]
inkwell = { git = "https://github.com/TheDan64/inkwell", branch = "llvm3-7", features = ["llvm3-7"] }
inkwell = { git = "https://github.com/TheDan64/inkwell", branch = "llvm3-7" }
```

Supported versions:

| GitHub Branch | Feature Flag |
| :-----------: | :----------: |
| llvm3-6 | llvm3-6 |
| llvm3-7 | llvm3-7 |
| llvm3-8 | llvm3-8 |
| LLVM Version | GitHub Branch |
| :----------: | :-----------: |
| 3.6.x | llvm3-6 |
| 3.7.x | llvm3-7 |
| 3.8.x | llvm3-8 |

In the root of your source code you will have to add an extern crate to begin using Inkwell:

Expand Down Expand Up @@ -118,8 +118,8 @@ fn jit_compile_sum(
```

<sup>1</sup> There are two uses of `unsafe` in this example because the actual
act of compiling and executing code on the fly is innately `unsafe`. For one,
there is no way of verifying we are calling `get_function()` with the right function
act of compiling and executing code on the fly is innately `unsafe`. For one,
there is no way of verifying we are calling `get_function()` with the right function
signature. It is also `unsafe` to *call* the function we get because there's no
guarantee the code itself doesn't do `unsafe` things internally (the same reason
you need `unsafe` when calling into C).
Expand Down

0 comments on commit 5a6dc48

Please sign in to comment.