aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorLukas Oesch <lukas.oesch@ost.ch>2026-06-10 10:40:46 +0200
committerLukas Oesch <lukas.oesch@ost.ch>2026-06-10 10:40:46 +0200
commit33abd5cf264cb9e34121082105b0bc17b3cf7a36 (patch)
tree36b15d53fea04f4f9d9af817100f7ad013bd9b5c /README.rst
parentd01caf1c4aef3c89c68b9d1cc9fe56445f0860b5 (diff)
parent7e27130c342b7299a1d2188a7192a7f17b5ac2ad (diff)
downloadkernel-33abd5cf264cb9e34121082105b0bc17b3cf7a36.tar.xz
kernel-33abd5cf264cb9e34121082105b0bc17b3cf7a36.zip
Merge branch 'develop-BA-FS26' into 'develop'HEADdevelop
Merge of BA-FS26 branch into develop See merge request teachos/kernel!49
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst14
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>``.