Skip to content

Commit 4e2bdf2

Browse files
committed
f tweak c-bindings-gen readme with suggestions from val
1 parent 939e66a commit 4e2bdf2

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

c-bindings-gen/README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
LDK C Bindings Generator
22
========================
33

4-
This program parses a Rust AST from a single-lib.rs Rust crate (passed in on stdin) and generates a
5-
second crate which is C-callable (and carries appropriate annotations for cbindgen). It is usually
6-
invoked via the `genbindings.sh` script in the top-level directory.
4+
This program parses a single-file-lib.rs Rust crate's AST passed in on stdin and generates a second
5+
crate which is C-callable (and carries appropriate annotations for cbindgen). It is usually invoked
6+
via the `genbindings.sh` script in the top-level directory, which converts the lightning crate into
7+
a single file with a call to
8+
`RUSTC_BOOTSTRAP=1 cargo rustc --profile=check -- -Zunstable-options --pretty=expanded`.
79

810
`genbindings.sh` requires that you have a rustc installed with the `wasm32-wasi` target available
911
(eg via the `libstd-rust-dev-wasm32` package on Debian or `rustup target add wasm32-wasi` for those

0 commit comments

Comments
 (0)