Commit 95f0ab0f authored by Ryan Hunt's avatar Ryan Hunt
Browse files

Improve formatting of README

parent 2dfc3c59
......@@ -45,22 +45,22 @@ fn main() {
## Configuration
There are a lot of configurable options for binding generation. Options can be specified by creating a `cbindgen.toml` with the options in the binding crate root. Alternatively, build scripts can specify options using `cbindgen::generate_with_config`.
There are some options that can be used to configure the binding generation. They can be specified by creating a `cbindgen.toml` with the options in the binding crate root. Alternatively, build scripts can specify them using `cbindgen::generate_with_config`.
Some useful options:
1. `header` - Optional text to output at the beginning of the file
2. `trailer` - Optional text to output at the end of the file
3. `include_guard` - Optional name to use for an include guard
4. `autogen_warning` - Optional text to output at major sections to deter manual editing
5. `include_version` - Whether to include a comment with the version of cbindgen used to generate the file
6. `braces` - The style to use for braces (can be either SameLine or NextLine)
7. `line_length` - The preferred length of a line, used when auto breaking function arguments
8. `tab_width` - The amount of spaces in an indentation
9. `language` - The language to generate bindings in (can be either C++ or C)
10. `parse_deps` - Whether to parse dependent crates
11. `include` - An optional whitelist to use when parsing dependent crates
12. `exclude` - An optional blacklist to use when parsing dependent crates
1. `header` - optional text to output at the beginning of the file
2. `trailer` - optional text to output at the end of the file
3. `include_guard` - optional name to use for an include guard
4. `autogen_warning` - optional text to output at major sections to deter manual editing
5. `include_version` - whether to include a comment with the version of cbindgen used to generate the file
6. `braces` - the style to use for braces (can be either SameLine or NextLine)
7. `line_length` - the preferred length of a line, used when auto breaking function arguments
8. `tab_width` - the amount of spaces in an indentation
9. `language` - the language to generate bindings in (can be either C++ or C)
10. `parse_deps` - whether to parse dependent crates
11. `include` - an optional whitelist to use when parsing dependent crates
12. `exclude` - an optional blacklist to use when parsing dependent crates
A full listing of options can be found in `src/bindgen/config.rs`
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment