Skip to content

Latest commit

 

History

History
83 lines (50 loc) · 2.46 KB

developing_zed__building_zed_linux.md

File metadata and controls

83 lines (50 loc) · 2.46 KB
Raw

Building Zed for Linux

Repository

After cloning the repository, ensure all git submodules are initialized:

git submodule update --init --recursive

Dependencies

  • Install Rust. If it's already installed, make sure it's up-to-date:

    rustup update

  • Install the necessary system libraries:

    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:

Alternatively, if you have Docker installed you can bring up all the collab dependencies using Docker Compose:

docker compose up -d

Building from source

Once you have the dependencies installed, you can build Zed using Cargo.

For a debug build:

cargo run

For a release build:

cargo run --release

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 (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) to figure out where the issue comes from.