From 6c80080ad994deafa0b0177e13a11befdda57b30 Mon Sep 17 00:00:00 2001
From: River Kanies <river.kanies@gmail.com>
Date: Thu, 21 Nov 2024 13:13:44 -0600
Subject: [PATCH] docs: to README.md add tests troubleshooting (run in series)

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index dafe923d6..71f1b2d34 100644
--- 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