Skip to content

Commit

Permalink
Update readme with bindgen feature
Browse files Browse the repository at this point in the history
  • Loading branch information
simonrw committed May 7, 2017
1 parent 4e7cbd6 commit 496935f
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,24 @@ Or pin a specific version:
fitsio = "0.2.0"
```

This repository contains `fitsio-sys-bindgen` which generates the C wrapper using `bindgen` at build time. This requires clang to build, and as this is likely to not be available in general, I do not recommend using it. It is contained here but is not actively developed, and untested. Use at your own peril.
This repository contains `fitsio-sys-bindgen` which generates the C
wrapper using `bindgen` at build time. This requires clang to build, and
as this is likely to not be available in general, I do not recommend
using it. It is contained here but is not actively developed, and
untested. Use at your own peril. To opt in to building with `bindgen`,
compile as:

```sh
cargo build --no-default-features --features bindgen
```

or use from your `Cargo.toml` as such:

```toml
[dependencies]
fitsio = { version = "0.2.0", default-features = false, features = ["bindgen"] }
```


## Documentation

Expand Down

0 comments on commit 496935f

Please sign in to comment.