docs: to README.md add tests troubleshooting (run in series)

bitcoindevkit · Nov 21, 2024 · 6c80080 · 6c80080
1 parent 3bc45b5
commit 6c80080
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -80,6 +80,20 @@ cargo update -p indexmap --precise "2.5.0"
 cargo update -p security-framework-sys --precise "2.11.1"
 ```
 
+## Troubleshooting Tests
+
+If tests are failing with `cargo test` it could be an issue related to tests that use bitcoind or electrsd running in parallel. This is known to affect MacOS users running tests locally. To force tests to run in series you can try:
+
+```
+cargo test -- --test-threads=1
+```
+
+or
+
+```
+RUST_TEST_THREADS=1 cargo test
+```
+
 ## License
 
 Licensed under either of