json-msg-pack
json-msg-pack copied to clipboard
Symlinking README.lhs to README.md does not work on Windows
Here's how I see it:
- We want GitHub to show a nice
README.md
- We want Stack/cabal to compile the same file but GHC requires that it has the
.lhs
file name extension - So we create a symlink
README.lhs
toREADME.md
This works fine on Linux. Unfortunately, with Git on Windows - which does not support symlinks in the same way - Git just creates a README.lhs
file containing the path to README.md
. Thus, compilation fails as the file does not contain any valid Haskell code.
Proposal: swap README.lhs
and README.md
round: make README.lhs
the file and README.md
the symlink. I have verified that this fixes the build on Windows and that GitHub is happy with it.
I'll submit a PR soon.
-Richard
Ping.