From 43d347f38de5051686342e4bfa38ffedcc99ebf7 Mon Sep 17 00:00:00 2001
From: Sebastian Graf <sgraf1337@gmail.com>
Date: Fri, 11 Jan 2019 04:48:07 -0500
Subject: [PATCH] Mention symlink situation on Git for Windows in README.md

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index a72a09e..69e16a6 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,19 @@ system GHC:
 
 ## Using
 
+<details>
+  <summary>Git symlink support for Windows machines</summary>
+  
+  NoFib uses a few symlinks here and there to share code between benchmarks.
+  Git for Windows has symlinks support for some time now, but
+  [it may not be enabled by default](https://stackoverflow.com/a/42137273/388010).
+  You will notice strange `make boot` failures if it's not enabled for you.
+  
+  Make sure you follow the instructions in the link to enable symlink support,
+  possibly as simple as through `git config core.symlinks true` or cloning with
+  `git clone -c core.symlinks=true <URL>`.
+</details>
+
 Then, to run the tests, execute:
 
 ```
-- 
GitLab