Skip to content

Commit

Permalink
Clarify documenation
Browse files Browse the repository at this point in the history
+ Improve installation instructions
+ cl-bindgen already ignores non-fatal errors
  • Loading branch information
sdilts committed Feb 10, 2020
1 parent e9f8def commit 9b84feb
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,17 @@ cl-bindgen requires `libclang`, which is not installed with the other Python
dependencies and not available on PyPi. It is recommended to install it first before installing
cl-bindgen. Use your distribution's package manager to install it.

From pip:
Once `libclang` is installed, you can then install `cl-bindgen` from
source or from PyPI.

From PyPI:
``` bash
pip install --user cl-bindgen
pip install cl-bindgen
```
From source:
``` bash
git clone --depth=1 https://github.com/sdilts/cl-bindgen
cd cl-bindgen
pip install --user .
```
## Processing individual files
Expand Down Expand Up @@ -58,7 +63,7 @@ Required Fields:
Optional Fields:
+ `package` : The name of the Common Lisp package of the generated file
+ `arguments` : Arguments to pass to clang
+ `force` : Ignore errors while parsing. Valid values are "True" or "False"
+ `force` : Ignore errors while parsing. Valid values are `True` or `False`

To see example batch files, look in the
[examples](https://github.com/sdilts/cl-bindgen/tree/master/examples)
Expand All @@ -79,7 +84,7 @@ If a header file isn't found while processing the input files,
cl-bindgen will halt and produce no output. This is to avoid producing
incorrect bindings: while bindings can still be produced when header
files are missing, they are likely to be incorrect. To ignore missing
header files and other errors, the `-f` flag can be used:
header files and other fatal errors, the `-f` flag can be used:

``` bash
cl-bindgen b -f batch_file.yaml
Expand Down

0 comments on commit 9b84feb

Please sign in to comment.