Skip to content

Commit 7e54c56

Browse files
authored
Modified README Markdown Formatting (#8)
A bit of a spontaneous round of edits. I'm open to discussion if anything seems off or is unwanted. Thank you! * Spelling: ontop >> on top * Spelling: virtualisation >> virtualization (since the latter appears most often in the MD) * Formatting: use bullets for reference links (so they don't mush into a single line) * Formatting: change case of PowerShell to be titlecase * Formatting: titlecase Markdown headers * Formatting: combine two adjacent MD code fences into one code fence (same syntax/language) *Note: I plan to give the MD another re-read or two to see if there are any other tweaks.*
2 parents 028f12c + ca66b0e commit 7e54c56

File tree

1 file changed

+18
-20
lines changed

1 file changed

+18
-20
lines changed

README.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ We recommend using Windows Terminal for the best experience:
1818
- Windows 11 users: Windows Terminal is installed by default.
1919
- Windows 10 users: Download Windows Terminal from the [Microsoft Store](https://aka.ms/terminal).
2020

21-
# Quick start
21+
# Quick Start
2222

2323
**Ensure WSL2.4.4 or newer is installed.**
2424

@@ -32,15 +32,15 @@ We recommend using Windows Terminal for the best experience:
3232
>[!NOTE]
3333
> Default credentials are `clab:clab`
3434
35-
# WSL installation
35+
# WSL Installation
3636

3737
This distro makes use of WSL2, which requires that virtualization is enabled in your UEFI/BIOS.
3838

3939
This may appear as something called 'SVM (AMD-V)' or 'Intel VT-x' depending on your processor.
4040

4141
### Windows 11
4242

43-
Open powershell and type:
43+
Open PowerShell and type:
4444

4545
```powershell
4646
wsl --install
@@ -55,29 +55,27 @@ Restart your PC, and WSL2 should be installed.
5555
5656
**Instructions are from ['Manual installation steps for older versions of WSL'.](https://learn.microsoft.com/en-us/windows/wsl/install-manual)**
5757

58-
Open an elevated powershell window (as administrator) and paste the following two commands:
58+
Open an elevated PowerShell window (as administrator) and paste the following two commands:
5959

6060
```powershell
6161
dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart
62-
```
6362
64-
```powershell
6563
dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart
6664
```
6765

6866
At this point restart your computer. After it has rebooted download the latest WSL2 kernel. [Download link](https://wslstorestorage.blob.core.windows.net/wslblob/wsl_update_x64.msi).
6967

7068
Follow the installation wizard. After completion finally set WSL2 as the default version of WSL.
7169

72-
In powershell or command prompt paste the following:
70+
In PowerShell or command prompt paste the following:
7371

7472
```powershell
7573
wsl --set-default-version 2
7674
```
7775

78-
## Version check
76+
## Version Check
7977

80-
Run `wsl --version` in powershell or command prompt to ensure WSL2 is enabled. The WSL version number should be 2.4.4.0 or higher.
78+
Run `wsl --version` in PowerShell or command prompt to ensure WSL2 is enabled. The WSL version number should be 2.4.4.0 or higher.
8179

8280
```powershell
8381
PS C:\Users\Kaelem> wsl --version
@@ -90,7 +88,7 @@ DXCore version: 10.0.26100.1-240331-1435.ge-release
9088
Windows version: 10.0.19044.5131
9189
```
9290

93-
# Distro installation
91+
# Distro Installation
9492

9593
**Ensure WSL is enabled and you have WSL 2.4.4 or newer. See the [version check](#version-check) instructions.**
9694

@@ -103,7 +101,7 @@ Windows version: 10.0.19044.5131
103101
104102
3. From the start menu you can launch the distribution from a new 'Containerlab' shortcut which has been added.
105103

106-
or in powershell/cmd you can execute:
104+
or in PowerShell/cmd you can execute:
107105

108106
```powershell
109107
wsl -d Containerlab
@@ -133,7 +131,7 @@ Windows version: 10.0.19044.5131
133131
134132
- From the profile in Windows Terminal (recommended).
135133
- From the shortcut in the start menu.
136-
- Executing `wsl -d Containerlab` in powershell or command prompt.
134+
- Executing `wsl -d Containerlab` in PowerShell or command prompt.
137135
138136
> [!NOTE]
139137
> Opening WSL via the shortcut or `wsl -d Containerlab` will not
@@ -145,7 +143,7 @@ Windows version: 10.0.19044.5131
145143
> [!IMPORTANT]
146144
> This feature is only supported on Windows 11.
147145
148-
You can run [vrnetlab (VM-based)](https://github.com/hellt/vrnetlab) nodes ontop of WSL2 and use them in containerlab. Containerlab WSL is already configured so that nested virtualisation is enabled on the distro side.
146+
You can run [vrnetlab (VM-based)](https://github.com/hellt/vrnetlab) nodes on top of WSL2 and use them in containerlab. Containerlab WSL is already configured so that nested virtualization is enabled on the distro side.
149147
150148
To use vrnetlab nodes on Containerlab WSL you must <u>ensure that nested virtualization is enabled globally in WSL</u>.
151149
@@ -155,7 +153,7 @@ To use vrnetlab nodes on Containerlab WSL you must <u>ensure that nested virtual
155153
156154
See the [containerlab user manual](https://containerlab.dev/manual/vrnetlab/) for more information about vrnetlab.
157155
158-
# Performance tuning
156+
# Performance Tuning
159157
160158
WSL2 runs as a VM. By default allocated resources are:
161159
@@ -167,7 +165,7 @@ WSL2 runs as a VM. By default allocated resources are:
167165
168166
Despite the fairly generous resource allocation by default. WSL2 will not use 100% of the assigned resources.
169167
170-
# Docker desktop
168+
# Docker Desktop
171169
172170
If you have Docker desktop installed. You **must** ensure the integration with the Containerlab WSL distro is disabled, otherwise Containerlab will not work inside Containerlab WSL.
173171
@@ -212,7 +210,7 @@ Clone the repository and build using the build script (you may have to `chmod +x
212210

213211
This will place `clab.wsl` in `C:\temp`. Doubleclick to install the distribution.
214212

215-
## Manual steps
213+
## Manual Steps
216214

217215
1. From inside a WSL distro Build the container:
218216

@@ -245,7 +243,7 @@ wsl --install --from-file clab.wsl
245243

246244
# Uninstallation
247245

248-
Uninstall Containerlab WSL using the following command in powershell/command prompt:
246+
Uninstall Containerlab WSL using the following command in PowerShell/command prompt:
249247

250248
```powershell
251249
wsl --unregister Containerlab
@@ -257,7 +255,7 @@ Ensure uninstallation by checking installed distros:
257255
wsl -l -v
258256
```
259257

260-
# Reference material
258+
# Reference Material
261259

262-
https://learn.microsoft.com/en-us/windows/wsl/use-custom-distro#export-the-tar-from-a-container
263-
https://learn.microsoft.com/en-us/windows/wsl/build-custom-distro
260+
* https://learn.microsoft.com/en-us/windows/wsl/use-custom-distro#export-the-tar-from-a-container
261+
* https://learn.microsoft.com/en-us/windows/wsl/build-custom-distro

0 commit comments

Comments
 (0)