Skip to content

Commit 6c8623e

Browse files
committed
docs: update readme
1 parent 05fe786 commit 6c8623e

File tree

1 file changed

+41
-22
lines changed

1 file changed

+41
-22
lines changed

README.md

Lines changed: 41 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,71 @@
1-
# WSL2 Kernel Builder
1+
# Let's build wsl2 kernels 🛠️
22

3-
This repository automates building custom WSL2 kernels using GitHub Actions.
3+
[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/lenML/lets-build-wsl2-kernels/build.yml?style=flat-square)](https://github.com/lenML/lets-build-wsl2-kernels/actions)
4+
[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)
45

5-
## Features
6+
This repository provides automated builds of Microsoft's official WSL2 kernel sources, compiling and releasing only the bzImage kernel files.
67

7-
- Build any WSL2 kernel version from Microsoft's repository
8-
- Manual trigger with custom version and config options
9-
- Weekly automatic builds of the latest stable version
10-
- Artifact with compiled kernel and config
8+
## Why This Exists ❓
119

12-
## Usage
10+
Microsoft maintains the [WSL2-Linux-Kernel](https://github.com/microsoft/WSL2-Linux-Kernel) but:
11+
- Doesn't provide pre-built historical kernel versions
12+
- Only distributes kernels through Windows Update
13+
- Makes it difficult to test different kernel versions
14+
15+
This project:
16+
- Automates building official Microsoft kernel sources exactly as released
17+
- Provides access to historical kernel versions
18+
- Only distributes the compiled bzImage (kernel binary)
19+
- Does NOT provide or modify any vhdx files
20+
21+
## Features ✨
22+
23+
- Builds any WSL2 kernel version from Microsoft's repository
24+
- Manual trigger with version selection
25+
- Weekly automatic builds of latest stable version
26+
- Provides only the bzImage kernel file
27+
- Clean builds with no modifications
28+
29+
## Usage 🚀
1330

1431
### Manual Build via GitHub UI
1532

1633
1. Go to "Actions" tab
1734
2. Select "Build WSL2 Kernel"
1835
3. Click "Run workflow"
19-
4. Specify kernel version (e.g. `5.15.150.1`)
20-
5. (Optional) Add extra config options (e.g. `CONFIG_USB_VIDEO_CLASS=y`)
21-
6. Click "Run workflow"
36+
4. Specify kernel version (e.g. `5.15.90.1`)
37+
5. Click "Run workflow"
2238

23-
### Download and Use Built Kernel
39+
### Install Compiled Kernel
2440

25-
1. After build completes, download the artifact
26-
2. Extract the `bzImage` file
27-
3. Place it in your desired location (e.g. `C:\Windows\System32\lxss\tools`)
28-
4. Create or modify `%USERPROFILE%\.wslconfig`:
41+
1. Download the bzImage artifact after build completes
42+
2. Place it in your preferred location (e.g. `C:\Windows\System32\lxss\tools`)
43+
3. Create/modify `%USERPROFILE%\.wslconfig`:
2944

3045
```ini
3146
[wsl2]
3247
kernel=C:\\path\\to\\bzImage
3348
```
3449

35-
5. Restart WSL: `wsl --shutdown`
50+
4. Restart WSL: `wsl --shutdown`
3651

3752
### Local Build
3853

39-
To build locally, run:
54+
To build locally from official sources:
4055

4156
```bash
42-
./scripts/build.sh [version] [extra_config]
57+
./scripts/build.sh [version]
4358
```
4459

4560
Example:
4661
```bash
47-
./scripts/build.sh 5.15.150.1 "CONFIG_USB_VIDEO_CLASS=y"
62+
./scripts/build.sh 5.15.90.1
4863
```
4964

50-
## Supported Versions
65+
## Supported Versions 📦
66+
67+
All versions from Microsoft's [WSL2-Linux-Kernel](https://github.com/microsoft/WSL2-Linux-Kernel/tags) can be built.
68+
69+
## License 📄
5170

52-
Check available versions at [Microsoft's WSL2-Linux-Kernel repository](https://github.com/microsoft/WSL2-Linux-Kernel/tags)
71+
Kernel code is under Microsoft's original licenses. Build scripts are MIT licensed.

0 commit comments

Comments
 (0)