Skip to content

Commit c5ee246

Browse files
committed
Update README
Address comments Fix documentation
1 parent 2fe4e1f commit c5ee246

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,16 +35,15 @@ In order to generate these bindings from scratch, you will need to clone two dep
3535

3636
**rust-lightning**, (a specific branch built for bindings compatibility)
3737
```shell
38-
git clone --branch 2021-03-java-bindings-base https://github.com/TheBlueMatt/rust-lightning /path/to/rust-lightning
38+
git clone --branch 2022-06-108-java-bindings https://github.com/TheBlueMatt/rust-lightning /path/to/rust-lightning
3939
```
4040

4141
**ldk-c-bindings**
4242
```shell
43-
git clone https://github.com/lightningdevkit/ldk-c-bindings /path/to/ldk-c-bindings
43+
git clone --branch v0.0.108.2 https://github.com/lightningdevkit/ldk-c-bindings /path/to/ldk-c-bindings
4444
```
4545

4646
Take note of where you clone these directories, it's best you save the absolute path somewhere handy for the rest of the remaining steps.
47-
4847
### Generating Rust-to-C-bindings
4948

5049
Now, navigate to the `ldk-c-bindings` directory and run the `genbindings.sh` script:
@@ -93,7 +92,7 @@ Take that commit hash and replace the `xxx` instances with it.
9392
To generate the Swift files, navigate to the `ldk-swift` repository and run the following:
9493

9594
```shell
96-
export LDK_SWIFT_GENERATOR_INPUT_HEADER_PATH="$(pwd)/path/to/ldk-c-bindings/lightning-c-bindings/include/lightning.h"
95+
export LDK_SWIFT_GENERATOR_INPUT_HEADER_PATH="/path/to/ldk-c-bindings/lightning-c-bindings/include/lightning.h"
9796
python3 ./
9897
```
9998

@@ -102,15 +101,15 @@ Now, the contents of the `bindings/LDK` folder will have been completely regener
102101
### Configuring Xcode for Framework Compilation
103102
Go to the `xcode` folder and open `LDKFramework.xcworkspace`.
104103

105-
Then, navigate to the "LDKFramework" project and click on the LDKFramework target:
104+
Then, navigate to the "LDKFramework" project and click on the LDKFramework project target:
106105
![](https://user-images.githubusercontent.com/5944973/175575527-97073a18-76fc-4ab0-928f-d40ac643e607.png)
107106

108-
Search for "LDK_DIRECTORY":
109-
![](https://user-images.githubusercontent.com/5944973/175575621-38224096-4baa-44cc-8345-ec2b871fcbe6.png)
107+
Search for `LDK_C_BINDINGS_BASE`:
108+
![](https://user-images.githubusercontent.com/5944973/177420117-bcf7fc32-b07d-440f-84d1-fe2d373c355b.png)
110109

111-
Here, enter the absolute path you to ldk-c-bindings you saved above.
110+
Here, enter the absolute path, pointing to your `ldk-c-bindings`.
112111

113-
Now, do the same for the "LDKFramework_Mac" target.
112+
You will now also have to do the same for `LDK_C_BINDINGS_BINARY_DIRECTORY`, and enter any directory you wish. We like to use just `bin/`.
114113

115114
#### Generating the *.xcframework files
116115

0 commit comments

Comments
 (0)