Skip to content

Commit 0da5f22

Browse files
committed
README.md: Consolidate WSL specific instructions
Move all of the documentation specific to the WSL kernel into README.md. The README.md file is displayed in the GitHub web interface in favor of the upstream README file. Leave a symlink from README-Microsoft.WSL2 to README.md so that anyone watching that file for changes will continue to see updates. While consolidating documentation, clean up trailing spaces and adjust the build dependency installation instructions to include the missing apt command. Signed-off-by: Tyler Hicks <[email protected]>
1 parent 9ec77af commit 0da5f22

File tree

3 files changed

+26
-26
lines changed

3 files changed

+26
-26
lines changed

README

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -16,24 +16,3 @@ several of them using the Restructured Text markup notation.
1616
Please read the Documentation/process/changes.rst file, as it contains the
1717
requirements for building and running the kernel, and information about
1818
the problems which may result by upgrading your kernel.
19-
20-
============
21-
22-
The WSL 2 Linux kernel repo provides the additional infrastructure necessary
23-
to build and release the kernel component of WSL 2. It was never designed to
24-
replace the current existing community and feedback channels for WSL,
25-
especially through: https://github.com/microsoft/WSL. This is why we are not
26-
accepting issues or pull requests through this repository.
27-
28-
If you have an issue relating to WSL, or the WSL 2 Linux kernel configuration,
29-
please report it at the WSL GitHub: would like contribute to or report an issue
30-
on the WSL2 kernel, please do so at the WSL GitHub:
31-
32-
https://github.com/microsoft/WSL/issues/new/choose
33-
34-
The WSL 2 Linux kernel is based on the Linux version from
35-
https://www.kernel.org/. If you would like to contribute to or report an issue
36-
on the Linux kernel in general, please do so on the upstream Linux GitHub:
37-
38-
https://www.kernel.org/doc/html/latest/process/submitting-patches.html
39-

README-Microsoft.WSL2

Lines changed: 0 additions & 5 deletions
This file was deleted.

README-Microsoft.WSL2

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
README.md

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
= Introduction =
2+
3+
The WSL 2 Linux kernel repo provides the additional infrastructure necessary
4+
to build and release the kernel component of WSL 2. It was never designed to
5+
replace the current existing community and feedback channels for WSL,
6+
especially through: https://github.com/microsoft/WSL. This is why we are not
7+
accepting issues or pull requests through this repository.
8+
9+
If you have an issue relating to WSL, or the WSL 2 Linux kernel configuration,
10+
please report it at the WSL GitHub: would like contribute to or report an issue
11+
on the WSL2 kernel, please do so at the WSL GitHub:
12+
13+
https://github.com/microsoft/WSL/issues/new/choose
14+
15+
The WSL 2 Linux kernel is based on the Linux version from
16+
https://www.kernel.org/. If you would like to contribute to or report an issue
17+
on the Linux kernel in general, please do so on the upstream Linux GitHub:
18+
19+
https://www.kernel.org/doc/html/latest/process/submitting-patches.html
20+
21+
= Build Instructions =
22+
23+
1. Install a recent Ubuntu distribution
24+
2. sudo apt install build-essential flex bison libssl-dev libelf-dev
25+
3. make KCONFIG_CONFIG=Microsoft/config-wsl

0 commit comments

Comments
 (0)