Skip to content

Commit

Permalink
Clarify some elements of the README and wrap lines
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthewLM committed Jan 7, 2024
1 parent d6be0c1 commit ad9cb8f
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions coinlib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,19 +84,22 @@ To build the dynamic library, run `dart run coinlib:build_macos` which will
place the library under a `build` directory.

## Building for Windows

### Native Windows build

The Windows shared library can be built using `dart run coinlib:build_windows` in
the root directory of your package which will produce a shared library into
`build/libsecp256k1.dll`. This can also be run in the `coinlib` root directory
via `dart run bin/build_windows.dart`.

Windows builds use the Visual Studio 17 2022 generator. Earlier Visual Studio toolchains may work by editing `bin/build_windows.dart`.
Windows builds use the Visual Studio 17 2022 generator. Earlier Visual Studio
toolchains may work by editing `bin/build_windows.dart`.

### Cross-compiling for Windows from Linux

Cross-compile a secp256k1 DLL for Windows on an Ubuntu 20.04 host with
`dart run coinlib:build_windows_crosscompile` or `dart run bin/build_windows_crosscompile.dart`.
`dart run coinlib:build_windows_crosscompile`. This can also be run in the
`coinlib` root directory via `dart run bin/build_windows_crosscompile.dart`.

### Cross-compiling for Windows using WSL

Expand All @@ -117,12 +120,12 @@ apt-get update -y
apt-get install -y autoconf libtool build-essential git cmake mingw-w64
```

Then, cross-compile a secp256k1 DLL for Windows on an Ubuntu 20.04 WSL2
instance on a Windows host with `dart run coinlib:build_wsl` or
`dart run bin/build_wsl.dart`, or complete the above
["Building for Windows on Linux"](#building-for-windows-on-linux) after
installing Docker or Podman in WSL. The build can also be completed without
installing Flutter to WSL by following
Then, cross-compile a secp256k1 DLL for Windows on an Ubuntu 20.04 WSL2 instance
on a Windows host with `dart run coinlib:build_wsl` or
`dart run bin/build_wsl.dart` in the `coinlib` root directory, or complete the
above ["Building for Windows on Linux"](#building-for-windows-on-linux) after
installing Docker or Podman in WSL. The build can also be completed without
installing Flutter to WSL by following
[bitcoin-core/secp256k1's "Cross compiling" guide](https://github.com/bitcoin-core/secp256k1?tab=readme-ov-file#cross-compiling).

## Development
Expand Down

0 comments on commit ad9cb8f

Please sign in to comment.