diff --git a/docs/src/development/freebsd.md b/docs/src/development/freebsd.md index 33ff9a56d9..199e653a65 100644 --- a/docs/src/development/freebsd.md +++ b/docs/src/development/freebsd.md @@ -16,15 +16,36 @@ Clone the [Zed repository](https://github.com/zed-industries/zed). 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 -### ⚠️ WebRTC Notice +Once the dependencies are installed, you can build Zed using [Cargo](https://doc.rust-lang.org/cargo/). -Currently, building `webrtc-sys` on FreeBSD fails due to missing upstream support and unavailable prebuilt binaries. -This is actively being worked on. +For a debug build of the editor: -More progress and discussion can be found in [Zed’s GitHub Discussions](https://github.com/zed-industries/zed/discussions/29550). +```sh +cargo run +``` -_Environment: -FreeBSD 14.2-RELEASE -Architecture: amd64 (x86_64)_ +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`.