From 79c559cc6534e1fdda2a9756e88340482ec67678 Mon Sep 17 00:00:00 2001
From: aphorise <aphorise@gmail.com>
Date: Thu, 1 Aug 2024 00:48:48 +0200
Subject: [PATCH] README.md - build instructions refined (#27540)

Added notes for fix when encountering the error below as part of either `make bootstrap` or `made dev`
---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/README.md b/README.md
index a67a3dce83..8139fa6d75 100644
--- a/README.md
+++ b/README.md
@@ -123,6 +123,15 @@ $ make test TEST=./vault
 ...
 ```
 
+### Troubleshooting
+
+If you encounter an error like `could not read Username for 'https://github.com'` you may need to adjust your git config like so:
+
+```sh
+$ git config --global --add url."git@github.com:".insteadOf "https://github.com/"
+```
+
+
 ### Importing Vault
 
 This repository publishes two libraries that may be imported by other projects: