Skip to content

Commit 5a6dc48

Browse files
committed
Clarified in README that branch usage doesn't require explicit feature use
1 parent 99f3e0a commit 5a6dc48

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,16 @@ You'll need to point your Cargo.toml to a branch and use a feature flag correspo
2222

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

2828
Supported versions:
2929

30-
| GitHub Branch | Feature Flag |
31-
| :-----------: | :----------: |
32-
| llvm3-6 | llvm3-6 |
33-
| llvm3-7 | llvm3-7 |
34-
| llvm3-8 | llvm3-8 |
30+
| LLVM Version | GitHub Branch |
31+
| :----------: | :-----------: |
32+
| 3.6.x | llvm3-6 |
33+
| 3.7.x | llvm3-7 |
34+
| 3.8.x | llvm3-8 |
3535

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

@@ -118,8 +118,8 @@ fn jit_compile_sum(
118118
```
119119

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

0 commit comments

Comments
 (0)