351ba5023b
This adds documentation for building Zed on FreeBSD. Notice WebRTC/LiveKit remains unsupported on this platform for now. Follow-up to: - #33162 - #30981 Release Notes: - N/A --------- Co-authored-by: Peter Tripp <peter@zed.dev>
51 lines
1.3 KiB
Markdown
51 lines
1.3 KiB
Markdown
# Building Zed for FreeBSD
|
|
|
|
Note, FreeBSD is not currently a supported platform, and so this is a work-in-progress.
|
|
|
|
## Repository
|
|
|
|
Clone the [Zed repository](https://github.com/zed-industries/zed).
|
|
|
|
## Dependencies
|
|
|
|
- Install the necessary system packages and rustup:
|
|
|
|
```sh
|
|
script/freebsd
|
|
```
|
|
|
|
If preferred, you can inspect [`script/freebsd`](https://github.com/zed-industries/zed/blob/main/script/freebsd) and perform the steps manually.
|
|
|
|
## Building from source
|
|
|
|
Once the dependencies are installed, you can build Zed using [Cargo](https://doc.rust-lang.org/cargo/).
|
|
|
|
For a debug build of the editor:
|
|
|
|
```sh
|
|
cargo run
|
|
```
|
|
|
|
And to run the tests:
|
|
|
|
```sh
|
|
cargo test --workspace
|
|
```
|
|
|
|
In release mode, the primary user interface is the `cli` crate. You can run it in development with:
|
|
|
|
```sh
|
|
cargo run -p cli
|
|
```
|
|
|
|
### WebRTC Notice
|
|
|
|
Currently, building `webrtc-sys` on FreeBSD fails due to missing upstream support and unavailable prebuilt binaries. As a result, some collaboration features (audio calls and screensharing) that depend on WebRTC are temporarily disabled.
|
|
|
|
See [Issue #15309: FreeBSD Support] and [Discussion #29550: Unofficial FreeBSD port for Zed] for more.
|
|
|
|
## Troubleshooting
|
|
|
|
### Cargo errors claiming that a dependency is using unstable features
|
|
|
|
Try `cargo clean` and `cargo build`.
|