add some windows build tips to development.md

This commit is contained in:
Arya Irani 2022-07-29 14:00:34 -04:00
parent 476995a1ae
commit 4e755aaf84

View File

@ -68,3 +68,23 @@ its location on the command line.
`cabal v2-install --project-file=contrib/cabal.project unison`
* The install directory can be modified with the option `--installdir: ...`
## Building on Windows
### I get an error about unison/sql/something
This codebase uses symlinks as a workaround for some inconveniences in the `here` package. Support for symlinks in Windows is relatively new, and isn't enabled by default. As a result, your cloned copy of the code probably won't work.
First you'll need to enable "Developer Mode" in your Windows settings.
Then you'll need to enable symlink support in your `git` configuration, e.g.
`git config core.symlinks true`
And then ask `git` to fix up your symlinks with `git checkout .`
More context at: https://stackoverflow.com/a/59761201/310162
### I get an error about `removeDirectoryRecursive`/`removeContentsRecursive`/`removePathRecursive`/`permission denied (Access is denied.)`
Stack doesn't work deterministically in Windows due to mismatched expectations about how file deletion works. If you get this error, you can just retry the build and it will probably make more progress than the last time.