Additional setup instructions for Windows/WSL

[VictoriaSchleis]

When trying to install Oscar on Windows, the following problem occurs quite frequently:

Oscar needs 6GB of RAM. The standard WSL setup has 4GB of RAM. It is not immediately obvious that this is the issue. Instead of throwing an error, Oscar just gets stuck compiling.

There is an easy fix to this: one needs to change the corresponding config file.

I propose to change the instructions for the Windows setup in the following (or a very similar) way:

• In WSL, check free
• If the free RAM is smaller than 6GB, save the attached config file wslconfig.txt in your C:User/"your username" branch and rename it to .wslconfig (with a dot in the beginning and without any file type ending! This is possible, for instance, using Notepad, changing the data type to "All Types")
• Close WSL, open the PowerShell
• type wsl --shutdown
• restart WSL and continue with the Oscar installation

worked out with @MichaelSchloesser

[joschmitt]

Seeing that you already have a proposal what should be added, can you (or @MichaelSchloesser?) make a pull request for the OSCAR website with this? There is a "Edit this page" button in the sidebar of https://www.oscar-system.org/install/ .

[thofma]

We added recently the hint that one needs 6GB of memory for WSL, see https://www.oscar-system.org/install/ and the Windows subsection. There we refer to the official WSL documentation on how to increase the memory.

We could link directly to the https://learn.microsoft.com/en-us/windows/wsl/wsl-config#example-wslconfig-file section though.