diff options
| author | Bobby Raduloff <bobbyraduloff@gmail.com> | 2019-08-02 14:57:14 +0300 |
|---|---|---|
| committer | Andreas Kling <awesomekling@gmail.com> | 2019-08-02 13:57:14 +0200 |
| commit | 0b94f9c236fb693a824b5a2f6ef43e76c5653c04 (patch) | |
| tree | dd526c1268961243b7b92e6b96b9291c339b6133 | |
| parent | fe25426ee4b8fbded17ec83325919dc80b0c1532 (diff) | |
| download | serenity-0b94f9c236fb693a824b5a2f6ef43e76c5653c04.zip | |
Meta: Added instructions for WSL in the README. (#399)
| -rw-r--r-- | ReadMe.md | 18 |
1 files changed, 18 insertions, 0 deletions
@@ -67,6 +67,23 @@ Once you've done both of those, go into the `Kernel/` directory, then run Later on, when you `git pull` to get the latest changes, there's no need to rebuild the toolchain. You can simply rerun **./makeall.sh** in the `Kernel/` directory and you'll be good to **./run** again. +## Notes on WSL + +SerenityOS can also be build and run under WSL Version 2. WSL Version 1 is not supported since Version 1 does not support ext2, which is needed for the setup. + +WSL Version 2 is currently only available for Insider Builds of Windows which are more unstable and prone to crashes. Therefore, running SerenityOS on WSL Version 2 and running Insider Builds, in general, is not recommended on production systems. + +Nevertheless, here is a guide on how to [get an Insider Build](https://insider.windows.com/en-us/how-to-pc/) and how to [get WSL2](https://docs.microsoft.com/en-us/windows/wsl/wsl2-install). The installation then procedes as usual. + +WSL2 does not natively support graphical applications. This means that to actually **./run** SerenityOS, you need an X Server for windows. [Vcxsrv](https://sourceforge.net/projects/vcxsrv/) is a good option. When you start up Vcxsrv, make sure to set the Display number to 0, and to Disable access control. Before actually doing **./run**, you need to set the DISPLAY environmental variable as such: + +``` +export DISPLAY=$(cat /etc/resolv.conf | grep nameserver | awk '{print $2}'):0 +``` +This is due to a bug in WSL2. For more information, microsoft/WSL#4106. + +Now you can finally, **./run**. + ## IRC Come chat in `#serenityos` on the Freenode IRC network. @@ -84,3 +101,4 @@ Feel free to append yourself here if you've made some sweet contributions. :) ## License Serenity is licensed under a 2-clause BSD license. + |