diff --git a/docs/src/getting-started.md b/docs/src/getting-started.md index 2dd04c70a944a06fe15854d98826b174b95bb94b..6bd34ad5cc387bc4fb208334f206aabc047d37b8 100644 --- a/docs/src/getting-started.md +++ b/docs/src/getting-started.md @@ -20,6 +20,10 @@ As well as Zed preview: brew install --cask zed@preview ``` +### Windows + +Get the latest stable builds via [the download page](https://zed.dev/download). If you want to download our preview build, you can find it on its [releases page](https://zed.dev/releases/preview). After the first manual installation, Zed will periodically check for install updates. + ### Linux For most Linux users, the easiest way to install Zed is through our installation script: diff --git a/docs/src/key-bindings.md b/docs/src/key-bindings.md index cf3acf82b8e665fac5e499c8a9c57f5fb24b9cde..1ce148bcf118bce61e113074ad321f27344aec04 100644 --- a/docs/src/key-bindings.md +++ b/docs/src/key-bindings.md @@ -23,8 +23,12 @@ For more information, see the documentation for [Vim mode](./vim.md) and [Helix ## User keymaps -Zed reads your keymap from `~/.config/zed/keymap.json`, which you can open with the {#action zed::OpenKeymap} action from the command palette. -You can also edit your keymap through the Zed Keymap Editor, accessible via the {#action zed::OpenKeymap} action or the {#kb zed::OpenKeymap} keybinding. +Where Zed looks for your keymap: + +- macOS/Linux: `~/.config/zed/keymap.json` +- Windows: `~\AppData\Roaming\Zed/keymap.json` + +You can open the keymap with the {#action zed::OpenKeymapFile} action from the command palette, or edit it in Zed's Keymap Editor, accessible via the {#action zed::OpenKeymap} action or the {#kb zed::OpenKeymap} keybinding. The `keymap.json` file contains a JSON array of objects with `"bindings"`. If no `"context"` is set, the bindings are always active. If it is set, the binding is only active when the [context matches](#contexts). @@ -51,7 +55,11 @@ For example: ] ``` -You can see all of Zed's default bindings in the default keymaps for [macOS](https://github.com/zed-industries/zed/blob/main/assets/keymaps/default-macos.json) or [Linux](https://github.com/zed-industries/zed/blob/main/assets/keymaps/default-linux.json). +You can see all of Zed's default bindings in the default keymaps for: + +- [macOS](https://github.com/zed-industries/zed/blob/main/assets/keymaps/default-macos.json) +- [Windows](https://github.com/zed-industries/zed/blob/main/assets/keymaps/default-windows.json) +- [Linux](https://github.com/zed-industries/zed/blob/main/assets/keymaps/default-linux.json). If you want to debug problems with custom keymaps, you can use `dev: Open Key Context View` from the command palette. Please file [an issue](https://github.com/zed-industries/zed) if you run into something you think should work but isn't. @@ -130,7 +138,7 @@ If you're using Vim mode, we have information on how [vim modes influence the co ### Actions Almost all of Zed's functionality is exposed as actions. -Although there is no explicitly documented list, you can find most of them by searching in the command palette, by looking in the default keymaps for [macOS](https://github.com/zed-industries/zed/blob/main/assets/keymaps/default-macos.json) or [Linux](https://github.com/zed-industries/zed/blob/main/assets/keymaps/default-linux.json), or by using Zed's autocomplete in your keymap file. +Although there is no explicitly documented list, you can find most of them by searching in the command palette, by looking in the default keymaps for [macOS](https://github.com/zed-industries/zed/blob/main/assets/keymaps/default-macos.json), [Windows](https://github.com/zed-industries/zed/blob/main/assets/keymaps/default-windows.json) or [Linux](https://github.com/zed-industries/zed/blob/main/assets/keymaps/default-linux.json), or by using Zed's autocomplete in your keymap file. Most actions do not require any arguments, and so you can bind them as strings: `"ctrl-a": "language_selector::Toggle"`. Some require a single argument and must be bound as an array: `"cmd-1": ["workspace::ActivatePane", 0]`. Some actions require multiple arguments and are bound as an array of a string and an object: `"ctrl-a": ["pane::DeploySearch", { "replace_enabled": true }]`. diff --git a/docs/src/system-requirements.md b/docs/src/system-requirements.md index 46c559c507acc27ebe30094adc99bdaf28f8e0b8..eaf9c027be5cef93c2dea0149e7e55dcdd8eb154 100644 --- a/docs/src/system-requirements.md +++ b/docs/src/system-requirements.md @@ -14,7 +14,6 @@ Zed supports the follow macOS releases: | macOS 12.x | Monterey | EOL 2024-09-16 | Supported | | macOS 11.x | Big Sur | EOL 2023-09-26 | Partially Supported | | macOS 10.15.x | Catalina | EOL 2022-09-12 | Partially Supported | -| macOS 10.14.x | Mojave | EOL 2021-10-25 | Unsupported | The macOS releases labelled "Partially Supported" (Big Sur and Catalina) do not support screen sharing via Zed Collaboration. These features use the [LiveKit SDK](https://livekit.io) which relies upon [ScreenCaptureKit.framework](https://developer.apple.com/documentation/screencapturekit/) only available on macOS 12 (Monterey) and newer. @@ -43,7 +42,20 @@ Zed requires a Vulkan 1.3 driver, and the following desktop portals: ## Windows -Not yet available as an official download. Can be built [from source](./development/windows.md). +Zed supports the follow Windows releases: +| Version | Microsoft Status | Zed Status | +| ------------------------- | ------------------ | ------------------- | +| Windows 11 (all releases) | Supported | Supported | +| Windows 10 (64-bit) | Supported | Supported | + +### Windows Hardware + +Zed supports machines with Intel or AMD 64-bit (x86_64) processors that meet the above Windows requirements: + +- Windows 11 (64-bit) +- Windows 10 (64-bit) +- Graphics: A GPU that supports DirectX 11 (most PCs from 2012+). +- Driver: Current NVIDIA/AMD/Intel driver (not the Microsoft Basic Display Adapter). ## FreeBSD diff --git a/docs/src/windows.md b/docs/src/windows.md index 2594919cce4e72616ca8cfb292d4ecdf016d2dea..dbb6fbdd472a293774e56b3c4e1ec475eea0bc40 100644 --- a/docs/src/windows.md +++ b/docs/src/windows.md @@ -1,12 +1,60 @@ # Zed on Windows -Zed is not supported on Windows (yet). We have limited developer bandwidth, and a -new platform is a large undertaking. However, the community has developed -a build of Zed on Windows, and you can compile it yourself with these instructions: +## Installing Zed -- [Building for Windows](./development/windows.md) +Get the latest stable builds via [the download page](https://zed.dev/download). If you want to download our preview build, you can find it on its [releases page](https://zed.dev/releases/preview). After the first manual installation, Zed will periodically check for install updates. -For now, we welcome contributions from the community to improve Windows support. +You can also build zed from source, see [these docs](https://zed.dev/docs/development/windows) for instructions. -- [GitHub Issues with 'Windows' label](https://github.com/zed-industries/zed/issues?q=is%3Aissue+is%3Aopen+label%3Awindows) -- [Zed Community Discord](https://zed.dev/community-links) -> `#windows` +## Uninstall + +- Installed via installer: Use `Settings` → `Apps` → `Installed apps`, search for Zed, and click Uninstall. +- Built from source: Remove the build output directory you created (e.g., your target/install folder). + +Your settings and extensions live in your user profile. When uninstalling, you can choose to keep or remove them. + +## Remote Development (SSH) + +Zed supports SSH remoting on Windows and will prompt for credentials when needed. + +If you encounter authentication issues, confirm that your SSH key agent is running (e.g., ssh-agent or your Git client’s agent) and that ssh.exe is on PATH. + +## WSL Support + +Zed supports opening folders inside of WSL natively. + +To open a local folder inside a WSL container use the `projects: open in wsl` action and select the folder you want to open, after which you will be presented with a list of available WSL distributions to open the folder in. + +To open a folder that's already located inside of a WSL container use the `projects: open wsl` action and select the WSL distribution, after which you the distro will be added to the `Remote Projects` window where you will be able to open the folder, see [Remote Development](./remote-development.md) + +## Troubleshooting + +### Zed fails to start or shows a blank window + +- Update your GPU drivers from your GPU vendor (Intel/AMD/NVIDIA). +- Ensure hardware acceleration is enabled in Windows and not blocked by third‑party software. +- Try launching Zed with no extensions or custom settings to isolate conflicts. + +### Terminal issues + +If activation scripts don’t run, update to the latest version and verify your shell profile files are not exiting early. For Git operations, confirm Git Bash or PowerShell is available and on PATH. + +### SSH remoting problems + +When prompted for credentials, use the graphical askpass dialog. If it doesn’t appear, check for credential manager conflicts and that GUI prompts aren’t blocked by your terminal. + +### Graphics issues + +#### Zed fails to open / degraded performance + +Zed requires a DX11 compatible GPU to run, if Zed doesn't open for you it is possible that your GPU does not meet the minimum requirements. + +To check if your GPU supports DX11, you can use the following command: + +``` +dxdiag +``` + +Which will open the diagnostic tool that will show the minimum DirectX version your GPU supports under `System` → `System Information` → `DirectX Version`. + +You might also be trying to run Zed inside a virtual machine in which case it will use the emulated adapter that your VM provides, while Zed will work the performance will be degraded.