Merge branch 'windows-development-notes' into 'develop-BA-FS26'

add windows development notes

See merge request teachos/kernel!21

1 files changed, 13 insertions, 1 deletions

diff --git a/README.rst b/README.rst
index 716013d..c850c7f 100644
--- a/README.rst
+++ b/README.rst
@@ -45,4 +45,16 @@ The default build target generates a bootable image.
 On x86-64 for example, this image takes the form of a bootable, grub2 based ISO image.
 These images are designed to be booted in QEMU, and should theoretically also be bootable on real hardware.
 However, note that not warranty is provided, and the kernel code may irreparably destroy any physical hardware if booted on a real system.
-The VSCodium IDE configuration provides a launch task using QEMU, available for debugging (via F5) and direct launch as a task.
\ No newline at end of file
+The VSCodium IDE configuration provides a launch task using QEMU, available for debugging (via F5) and direct launch as a task.
+
+Notes for Development under Windows
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+While this repository and the devcontainer can be used from Windows, significant performance issues may occur.
+To reduce these issues, you can either set up a Linux VM for development, or, if that is not preferred, clone the repository inside WSL and open it from there with Visual Studio Code.
+
+| ``git clone <repo-url>``
+| ``cd <repo-folder>``
+| ``code .``
+
+If you use tools such as Git Extensions or GitHub Desktop, access the repository via the WSL network path, for example ``\\wsl.localhost\<distro>\<path-to-repo>``.