diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 18 |
1 files changed, 13 insertions, 5 deletions
@@ -10,7 +10,8 @@ Development ----------- Development happens primarily on Linux. -Other platforms (e.g. Windows, macOS) may allow building of the kernel as well, however at the time of writing they are not officially supported. +Other platforms may allow building of the kernel as well, however at the time of writing they are not officially supported. +Development on Windows has been tested in the past, see `Notes for Development on Windows`_ Required Tools ~~~~~~~~~~~~~~ @@ -18,10 +19,15 @@ Required Tools A precompiled toolchain, targeting only x86-64 as of the time of writing, is available in the `Devconainers <https://gitlab.ost.ch/teachos/devcontainers>`_ repository. The toolchain is provided both as a downloadable, self-contained archive and an Ubuntu Linux based Docker image. When using the downloadable archive, care must be taken to make the contained executables available in the user's or system path. -Also, when using the downloadable archive, further required tools, like CMake, QEMU, Ninja, xorisso, grub, etc. must be installed separately. +Also, when using the downloadable archive, further required tools, like ``CMake``, ``QEMU``, ``Ninja``, ``xorisso``, ``grub``, etc. must be installed separately. -The primary IDE used for development is VSCodium. +The primary IDE used for development is `Visual Studio Code <https://code.visualstudio.com/>`_. A configuration of runnable tasks, debugging settings, etc. as well as suggested extensions is provided. +The development container a + +Additionally, a basic IDE-like configuration for ``neovim`` (version 0.12+) is provided as well. +It relies on the presence of the `lazy.nvim <https://github.com/folke/lazy.nvim>`_ to install and load plugins. + Other IDEs might work, especially Visual Studio Code related ones, but no support is provided. Repository Structure @@ -47,8 +53,10 @@ These images are designed to be booted in QEMU, and should theoretically also be 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. -Notes for Development under Windows -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. _dev-support-windows: + +Notes for Development on 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. |