Skip to content

Commit 912ba66

Browse files
committed
Update README to reflect static linking changes
1 parent ca7129a commit 912ba66

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,13 @@ cd go-bitcoinkernel
3939
make build-kernel
4040
```
4141

42-
This command will configure Bitcoin Core's CMake build system and build only the `libbitcoinkernel` shared library. Refer to Bitcoin Core's build documentation to for the minimum requirements to compile `libbitcoinkernel` from source:
42+
This command will configure Bitcoin Core's CMake build system and statically compile the `libbitcoinkernel` library. Building requires CMake, a C++ compiler, Boost library, and Make. For platform-specific setup instructions, consult Bitcoin Core's build documentation:
4343
([Unix](./depend/bitcoin/doc/build-unix.md),
4444
[macOS](./depend/bitcoin/doc/build-osx.md),
4545
[Windows](./depend/bitcoin/doc/build-windows.md))
4646

47+
**Addtional note for Windows:** MinGW toolchain is required. CGo uses GCC on Windows, so static linking requires the library to be compiled with GCC/MinGW rather than MSVC for ABI compatibility.
48+
4749
### Step 3: Run Tests
4850

4951
```bash
@@ -92,8 +94,4 @@ call `Destroy()` methods when you're done with owned objects to free resources i
9294

9395
### Error Handling
9496

95-
The library uses structured error types for better error handling (see [errors.go](./kernel/errors.go)).
96-
97-
### Runtime Dependencies
98-
99-
Your Go application will have a runtime dependency on the shared `libbitcoinkernel` library produced by `make build-kernel` in `/path/to/go-bitcoinkernel/depend/bitcoin/build`. Do not delete or move these built library files as your application needs them to run.
97+
The library uses structured error types for better error handling (see [errors.go](./kernel/errors.go)).

0 commit comments

Comments
 (0)