RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-27 12:37:44 +00:00
Code Issues Activity Actions

Documentation: Clarify Windows build instructions

Browse source 
People seem to easily miss the "Setting up build tools" section, so I
have moved that step above the filesystem information and linked
directly to BuildInstructions.md to hopefully make it harder to skip.

Also, added mention of `\\wsl$` since that regularly comes up in
Discord.
This commit is contained in:
Sam Atkins 2021-09-10 14:52:11 +01:00 • committed by Brian Gianforcaro
parent c78838c2d2
commit f36781a8bc
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
Documentation/BuildInstructionsWindows.md
View file

@ -11,6 +11,9 @@ Once installed, you will need to make sure the distribution you want to use (and
- `wsl --set-version <distro> <version>` is used to convert a distro to another version, and<br/> - `wsl --set-version <distro> <version>` is used to convert a distro to another version, and<br/>
- `wsl --set-default-version 2` will set the default version for all new distros (if desired.)<br/> - `wsl --set-default-version 2` will set the default version for all new distros (if desired.)<br/>
Next, go to [BuildInstructions.md](https://github.com/SerenityOS/serenity/blob/master/Documentation/BuildInstructions.md#prerequisites)
and follow the instructions for your chosen Linux environment, to get the needed build tools.
## Note on filesystems ## Note on filesystems
WSL2 filesystem performance for IO heavy tasks (such as compiling a large C++ project) on the host Windows filesystem is WSL2 filesystem performance for IO heavy tasks (such as compiling a large C++ project) on the host Windows filesystem is
@ -21,11 +24,8 @@ The recommendation from the Microsoft team on that issue is:
> If it's at all possible, store your projects in the Linux file system in WSL2. > If it's at all possible, store your projects in the Linux file system in WSL2.
In practice, this means cloning and building the project to somewhere such as `/home/username/serenity`. In practice, this means cloning and building the project to somewhere such as `/home/username/serenity`. You can then
access the linux filesystem at `\\wsl$`, so for example, the project would be at `\\wsl$\home\username\serenity`.
## Setting up build tools
Please see the general build instructions for a list of tools you need to install in your WSL Linux environment.
## Setting up QEMU ## Setting up QEMU