diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..28493ac --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# wsl-tui + +A simple terminal interface to interact with having several [WSL](https://learn.microsoft.com/en-gb/windows/wsl/) distributions installed. + +## Config file + +See [example config](./config_example.toml). + +## Requirements + +- `go` 1.23 +- `wsl` if on Windows +- `SSH` if on any other platform or on Windows built with the `nohost` tag. + +### Building + +```bash +go build -ldflags "-s -w" -o wsl-tui +``` + +To use SSH on Windows instead of WSL, instead use the following: + +```bash +go build -ldflags "-s -w" -tags nohost -o wsl-tui +``` + +## License + +[MIT](./LICENSE) |