zed/docs/src/developing_zed__building_zed_linux.md
Marshall Bowers 48f0f387f8
Update docs for building Zed (#8092)
This PR updates the docs for building Zed to fix the links in the
sidebar after the addition of the Linux-specific docs in #8083.

Release Notes:

- N/A
2024-02-20 17:34:13 -05:00

1.5 KiB

Building Zed for Linux

Repository

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

git submodule update --init --recursive

Dependencies

  • Install Rust

  • Install the Rust wasm toolchain:

    rustup target add wasm32-wasi
    
  • 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

Note: 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 Zed 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

Troubleshooting

Cargo errors claiming that a dependency is using unstable features

Try cargo clean and cargo build.