From ad9cb8f2abac2a350b976b2f13a73870efb0b31c Mon Sep 17 00:00:00 2001 From: Matthew Mitchell Date: Sun, 7 Jan 2024 16:36:01 +0000 Subject: [PATCH] Clarify some elements of the README and wrap lines --- coinlib/README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/coinlib/README.md b/coinlib/README.md index dc53958..19aaf64 100644 --- a/coinlib/README.md +++ b/coinlib/README.md @@ -84,6 +84,7 @@ 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 @@ -91,12 +92,14 @@ 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 @@ -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