Skip to content

Commit 63eb7cf

Browse files
committed
Add README.md
1 parent 9a5525f commit 63eb7cf

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

README.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# wsl-tray
2+
3+
wsl-tray is a lightweight Windows tray application for easily managing WSL 2 VMs.
4+
5+
Whenever you need to conveniently terminate all WSL 2 VMs to free resources from the system, or just start a random distribution for a one-liner test, wsl-tray is your friend.
6+
7+
## Features
8+
9+
- Right-click from the system tray to get the only menu of this application.
10+
11+
- Click on any WSL distribution to toggle its status (Running <-> Stopped).
12+
13+
- Click on "Shutdown/Terminal All" to quickly free resources from WSL 2.
14+
15+
## Requirements
16+
- Windows Only
17+
- WSL 2 Only
18+
- Python 3.7+ if you are installing from PyPI
19+
20+
## Get the App
21+
22+
### Download the Binary
23+
24+
Head to [Release](https://github.com/yzgyyang/wsl-tray/releases) to download the latest release version.
25+
26+
Put a link to the file to Startup so it can quietly start with the system.
27+
28+
### Install from PyPI
29+
30+
Alternatively, if you already have Python 3.7+ installed, use [pip](https://pip.pypa.io/en/stable/) to install wsl-tray.
31+
32+
```bash
33+
pip install wsl-tray
34+
```
35+
36+
## Credits
37+
38+
`systray` portion of the code was imported from [infinidat/infi.systray](https://github.com/Infinidat/infi.systray) with some small modifications.
39+
40+
Icons made by [Pixel perfect](https://www.flaticon.com/authors/pixel-perfect) from [Flaticon](www.flaticon.com).
41+
42+
## License
43+
[BSD3](https://github.com/yzgyyang/wsl-tray/blob/master/LICENSE)

0 commit comments

Comments
 (0)