Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
mzuenni committed Feb 3, 2025
1 parent 2c583de commit 0fc5fb5
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,22 +54,24 @@ After cloning the repository, symlink [bin/tools.py](bin/tools.py) to somewhere
```

### Windows
For Windows the preferred way to use BAPCtools is inside the Windows Subsystem for Linux (WSL).

For Windows, you'll need the following in your
Note that BAPCtools makes use of symlinks for building programs. By default users are not allowed to create symlinks on Windows.
This can be fixed by enabling Developer Mode on Windows (Only since Windows 10, version 1703 or newer).<br>
In case you're still having problems with symlinks in combination with Git after enabling this setting,
please try the suggestions at https://stackoverflow.com/a/59761201.
Specifically, `git config -g core.symlinks true` should do the trick,
after which you can restore broken symlinks using `git checkout -- path/to/symlink`.

### Native Windows
If you cannot or do not want to use WSL you'll need the following in your
`path`:

- `Python` for Python 3
- `g++` to compile C++
- `javac` and `java` to compile and run `java`.

Resource limits (memory limit/hard cpu time limit) are also not supported.

BAPCtools makes use of symlinks for building programs. By default users are not allowed to create symlinks on Windows.
This can be fixed by enabling Developer Mode on Windows (Only since Windows 10, version 1703 or newer).<br>
In case you're still having problems with symlinks in combination with Git after enabling this setting,
please try the suggestions at https://stackoverflow.com/a/59761201.
Specifically, `git config -g core.symlinks true` should do the trick,
after which you can restore broken symlinks using `git checkout -- path/to/symlink`.
Resource limits (memory limit/hard cpu time limit) are not supported.

### Docker

Expand Down

0 comments on commit 0fc5fb5

Please sign in to comment.