From 0fc5fb505c050c0a1f844254b68c39b734aed96f Mon Sep 17 00:00:00 2001 From: MZuenni Date: Mon, 3 Feb 2025 13:16:09 +0100 Subject: [PATCH] update doc --- readme.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/readme.md b/readme.md index d711e4f2..59325e3f 100644 --- a/readme.md +++ b/readme.md @@ -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).
+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).
-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