Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions for getting make to work on Windows #651

Merged
merged 7 commits into from
Dec 16, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ When preparing a PR here are some general guidelines:
- To test your changes before submission, run `make` at the top level,
which will generate all required `Everything` files in
`Cubical/README.agda` and then typecheck the latter file.
If you're using Windows, [here](MAKEWINDOWS.md) are some instructions
to get the `make` command working.

- Please read through and clean your code before making a PR. Clean
code has reasonable line length (<100 characters), good indentation,
Expand Down
32 changes: 32 additions & 0 deletions MAKEWINDOWS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Instructions for getting `make` to work on Windows

The GNU command `make` does not work out of the box on Windows.
Here are some steps you could take to get `make` working on a Windows machine:

1. You probably already installed the Chocolatey package manager when
installing Agda (check by running `choco` in terminal). If not, install it
from [here](https://chocolatey.org/install).

2. You need to install the `make` command by running
```
choco install make
```

3. The [makefile](GNUmakefile) runs the `runhaskell` command, which might not
work on your system. Test this by running in terminal
```
runhaskell
```
If that doesn't work, create a file called `runhaskell.bat` with the contents
```
runghc %*
```
and put this somewhere in your PATH.

4. Give your user account `Read & Execute` access to `C:\Windows\System32\pthread.dll`

5. Now, **each time before you run `make`,** run the following command in your terminal:
```
chcp.com 65001
```
so that Haskell can parse UTF-8 characters.