diff options
author | bors-servo <lbergstrom+bors@mozilla.com> | 2017-04-26 17:49:55 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-04-26 17:49:55 -0500 |
commit | a371de097f5e37eb01754525fb1e2029ca88b0be (patch) | |
tree | f59c22e9c4b59a6aa1751b31f559abeb6ed6f91f /src/codegen/struct_layout.rs | |
parent | e6fa7be6aaccf34d6d2ae9335d357717a16b1839 (diff) | |
parent | 2d20e7e8ef602d8ecd5a87c0492133296595db74 (diff) |
Auto merge of #668 - fitzgen:users-guide, r=emilio
Add the `bindgen` Users Guide
This commit adds a Users Guide, built with [mdbook][] (the same tool used
by *The Rust Book*).
It moves all the user documentation from the README.md into the Users Guide. It
leaves the README.md as a splash page featuring an example of what `bindgen` is
and does, a link to the Users Guide, a link to the docs.rs/bindgen API reference
documentation, and a link to CONTRIBUTING.md.
It ensures that the Users Guide builds with `mdbook`, and all code snippets
within it build as doctests and pass, on every CI run.
Finally, it builds and uploads the Users Guide every time CI passes on the
master branch.
[mdbook]: https://github.com/azerupi/mdBook
r? @emilio see the rendered book here: https://servo.github.io/rust-bindgen/index.html
Diffstat (limited to 'src/codegen/struct_layout.rs')
0 files changed, 0 insertions, 0 deletions