From 1eb23a1e0a1e797584d5a4579a082a90d6f546fa Mon Sep 17 00:00:00 2001 From: Charles Kerr Date: Thu, 15 Sep 2022 10:52:26 -0700 Subject: [PATCH 1/2] docs: add a Common Pitfalls section to README say do not put spaces in your home directory --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 763d717e..a7b90678 100644 --- a/README.md +++ b/README.md @@ -434,3 +434,7 @@ Regardless of whether automatic updates are enabled, you can manually call the f ``` e auto-update check ``` + +# Common Pitfalls + +- Many of the tools that `build-tools` depends on will fail if you have spaces in your home directory. The easiest workaround is to use a different home directory. See [#134](https://github.com/electron/build-tools/issues/134) for more information. From 053866a8648c32c1b2069fb18c2edb83c512e3e1 Mon Sep 17 00:00:00 2001 From: Charles Kerr Date: Sat, 17 Sep 2022 08:20:48 -0700 Subject: [PATCH 2/2] Update README.md Co-authored-by: David Sanders --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a7b90678..07821902 100644 --- a/README.md +++ b/README.md @@ -435,6 +435,6 @@ Regardless of whether automatic updates are enabled, you can manually call the f e auto-update check ``` -# Common Pitfalls +## Common Pitfalls - Many of the tools that `build-tools` depends on will fail if you have spaces in your home directory. The easiest workaround is to use a different home directory. See [#134](https://github.com/electron/build-tools/issues/134) for more information.