Skip to content

Commit 1955627

Browse files
committed
chore: improve readme files
1 parent b0dc381 commit 1955627

File tree

3 files changed

+25
-5
lines changed

3 files changed

+25
-5
lines changed

Diff for: examples/wasm/js/README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44

55
Works when next to (in same parent folder as) the `rust` counter-part (pulls from `../rust` as a custom local npm package).
66

7-
run with `npm start`
8-
open browser to http://localhost:8080/
9-
open browser console to see scan rusults
7+
Get deps and run:
8+
```sh
9+
npm install
10+
npm start
11+
```
12+
13+
Open browser to http://localhost:8080/
14+
15+
Open browser console to see scan rusults

Diff for: examples/wasm/js/public/index.html

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
<title>BDK WASM Test</title>
66
</head>
77
<body>
8+
<h1>BDK WASM Custom Example</h1>
9+
<p>Open browser console to see output</p>
810
<script src="bundle.js"></script>
911
</body>
1012
</html>

Diff for: examples/wasm/rust/README.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,24 @@
22
# WASM Example
33

44
To run this example, cd into this folder and run:
5+
56
`wasm-pack build`
7+
68
then open a new terminal and cd to the `js` folder (next to this one) and follow the instructions in the README there.
79

8-
### Note
10+
Note: you will need to install wasm-pack if you don't have it (see below)
11+
12+
### Note for Mac
13+
14+
To build successfully on mac required installing llvm with homebrew (even though there's a default version) https://github.com/bitcoindevkit/bdk/issues/1671#issuecomment-2456858895
15+
16+
To resolve this we point to llvm in .cargo and .vscode folders.
17+
18+
### Non Mac
19+
20+
You may need to remove the pointers to llvm or point them to the appropriate location.
21+
922

10-
to build successfully on mac required installing llvm with homebrew (even though there's a default version) https://github.com/bitcoindevkit/bdk/issues/1671#issuecomment-2456858895
1123

1224
<br/><br/><br/><br/><br/><br/><br/><br/>
1325

0 commit comments

Comments
 (0)