b34ab6f3a1
This PR removes the references to initializing Git submodules as part of building Zed. These are no longer needed, as our only submodule was removed in #11672. Release Notes: - N/A
87 lines
2.5 KiB
Markdown
87 lines
2.5 KiB
Markdown
# Building Zed for Linux
|
|
|
|
## Repository
|
|
|
|
Clone down the [Zed repository](https://github.com/zed-industries/zed).
|
|
|
|
## Dependencies
|
|
|
|
- Install [Rust](https://www.rust-lang.org/tools/install). If it's already installed, make sure it's up-to-date:
|
|
|
|
```bash
|
|
rustup update
|
|
```
|
|
|
|
- Install the necessary system libraries:
|
|
|
|
```bash
|
|
script/linux
|
|
```
|
|
|
|
If you prefer to install the system libraries manually, you can find the list of required packages in the `script/linux` file.
|
|
|
|
## Backend dependencies
|
|
|
|
> [!WARNING]
|
|
> This section is still in development. The instructions are not yet complete.
|
|
|
|
If you are developing collaborative features of Zed, you'll need to install the dependencies of zed's `collab` server:
|
|
|
|
- Install [Postgres](https://www.postgresql.org/download/linux/)
|
|
- Install [Livekit](https://github.com/livekit/livekit-cli) and [Foreman](https://theforeman.org/manuals/3.9/quickstart_guide.html)
|
|
|
|
Alternatively, if you have [Docker](https://www.docker.com/) installed you can bring up all the `collab` dependencies using Docker Compose:
|
|
|
|
```sh
|
|
docker compose up -d
|
|
```
|
|
|
|
## Building from source
|
|
|
|
Once you have the dependencies installed, you can build Zed using [Cargo](https://doc.rust-lang.org/cargo/).
|
|
|
|
For a debug build:
|
|
|
|
```
|
|
cargo run
|
|
```
|
|
|
|
For a release build:
|
|
|
|
```
|
|
cargo run --release
|
|
```
|
|
|
|
For a release package:
|
|
|
|
```
|
|
cargo build --release
|
|
```
|
|
|
|
the binary can be found in `target/release` folder.
|
|
|
|
And to run the tests:
|
|
|
|
```
|
|
cargo test --workspace
|
|
```
|
|
|
|
## Wayland & X11
|
|
|
|
Zed has basic support for both modes. The mode is selected at runtime. If you're on wayland and want to run in X11 mode, you can set `WAYLAND_DISPLAY='' cargo run` to do so.
|
|
|
|
## Troubleshooting
|
|
|
|
### Can't compile zed
|
|
|
|
Before reporting the issue, make sure that you have the latest rustc version with `rustup update`.
|
|
|
|
### Cargo errors claiming that a dependency is using unstable features
|
|
|
|
Try `cargo clean` and `cargo build`.
|
|
|
|
### Vulkan/GPU issues
|
|
|
|
If Zed crashes at runtime due to GPU or vulkan issues, you can try running [vkcube](https://github.com/krh/vkcube) (usually available as part of the `vulkaninfo` package on various distributions) to try to troubleshoot where the issue is coming from. Try running in both X11 and wayland modes by running `vkcube -m [x11|wayland]`. Some versions of `vkcube` use `vkcube` to run in X11 and `vkcube-wayland` to run in wayland.
|
|
|
|
If you have multiple GPUs, you can also try running Zed on a different one (for example, with [vkdevicechooser](https://github.com/jiriks74/vkdevicechooser)) to figure out where the issue comes from.
|