diff --git a/quickstart.mdx b/quickstart.mdx index 9a18c5f..90faee9 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -14,6 +14,21 @@ description: 'After downloading Wave, get up and running quickly' 1. [Download Wave](https://www.commandline.dev/download) and extract the file 2. Change to the Wave directory ```cd waveterm-linux-* ``` 3. Run the application: ```./Wave``` + + While we work on improving the packaging for Linux, you can optionally create a `.desktop` file, allowing you to launch Wave directly. + After doing the above steps, create a file named `Wave.desktop`, and add the following, modifying the `Exec` and `Icon` paths to point to your Wave installation: + ``` + [Desktop Entry] + Type=Application + Name=Wave + Icon= /path/to/Wave-linux-*/resources/app/public/waveterm.icns + Exec=/path/to/Wave-linux-*/Wave + # setting this to true will launch an extra terminal to run the Wave command + Terminal=false + ``` + Run `desktop-file-validate Wave.desktop` to validate that the desktop entry is correct, then run `sudo cp Wave.desktop ~/.local/share/applications/Wave.desktop` to copy the entry into your application list. + After restarting your desktop environment (or your computer), Wave should be visible in application list, and should be launched by clicking the icon. + The `.desktop` file scheme is supported by most commonly used desktop environments such as GNOME, KDE, XFCE, etc. If encounter issues, please consider opening an issue on the GitHub repository. . Wave has support for WSL, tested on Ubuntu and Kali distros