Skip to content

Commit

Permalink
Readme explains how to enable long paths in git (#318)
Browse files Browse the repository at this point in the history
* Readme explains how to enable long paths in git
Fixes #317
* Add Windows long path warning
  • Loading branch information
neilenns authored May 23, 2024
1 parent c1452d7 commit 73a1d5f
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 73a1d5f

Please sign in to comment.