From bbe8708369d39e9cfb3f6f64dc31d58e54162e86 Mon Sep 17 00:00:00 2001 From: jahorton Date: Wed, 29 Apr 2020 14:19:26 +0700 Subject: [PATCH] chore(common): readme re: filepath length of repo base --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index f3e24fb61b..819500203d 100644 --- a/README.md +++ b/README.md @@ -69,3 +69,9 @@ Licensed under the [MIT](./windows/src/LICENSE.md) License. [linux-master]: https://build.palaso.org/app/rest/builds/buildType:(id:KeymanLinux_Master)/statusIcon [linux-beta]: https://build.palaso.org/app/rest/builds/buildType:(id:KeymanLinux_Beta)/statusIcon [linux-stable]: https://build.palaso.org/app/rest/builds/buildType:(id:KeymanLinux_Stable),branch:(default:false)/statusIcon + +# Notes for Contributors + +When cloning this repo for local development on a Windows machine, take care not to place it overly deep in your file system. +Some of the paths for compilation can push character lengths around 160 characters long, while certain operations on Windows systems may be limited to paths of 260 characters or less. +For example, [`git clean` on Windows with msys](https://stackoverflow.com/questions/22575662/filename-too-long-in-git-for-windows/22575737#22575737) is limited due to dependence on older Windows APIs. \ No newline at end of file