From 73a1d5f3de3aeec8901ddfc8a93da4568cfe2a0f Mon Sep 17 00:00:00 2001 From: Neil Enns Date: Thu, 23 May 2024 11:51:28 -0700 Subject: [PATCH] Readme explains how to enable long paths in git (#318) * Readme explains how to enable long paths in git Fixes #317 * Add Windows long path warning --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9bc6abb6..d06698f2 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,17 @@ PlatformIO version of the MobiFlight firmware source. -To build: +**Warning**: Before attempting to build the repo you must enable long path +support in git otherwise you will get a build failure on the Raspberry Pi Pico +build. To enable long paths type the following in a terminal window: + +```powershell +git config --global core.longpaths true +``` + +If you still receive an error then [enable long paths support in Windows](https://www.thewindowsclub.com/how-to-enable-or-disable-win32-long-paths-in-windows-11-10). + +## Building 1. Install [Visual Studio Code](https://code.visualstudio.com/Download) 2. Install the [PlatformIO extension](https://marketplace.visualstudio.com/items?itemName=platformio.platformio-ide). Visual Studio Code will automatically