diff options
| author | Sam Atkins <atkinssj@serenityos.org> | 2021-09-10 14:52:11 +0100 |
|---|---|---|
| committer | Brian Gianforcaro <b.gianfo@gmail.com> | 2021-09-10 14:05:25 +0000 |
| commit | f36781a8bca4e34cd364c9b09a753a9f605911f2 (patch) | |
| tree | 6260dbbc287c0f917456258951afe31fe851ee3b /Documentation | |
| parent | c78838c2d247d9e838095f15faebb8a404c07242 (diff) | |
| download | serenity-f36781a8bca4e34cd364c9b09a753a9f605911f2.zip | |
Documentation: Clarify Windows build instructions
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.
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/BuildInstructionsWindows.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/Documentation/BuildInstructionsWindows.md b/Documentation/BuildInstructionsWindows.md index e8ca0b329b..b97077ce51 100644 --- a/Documentation/BuildInstructionsWindows.md +++ b/Documentation/BuildInstructionsWindows.md @@ -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-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 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. -In practice, this means cloning and building the project to somewhere such as `/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. +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 QEMU |