docs: Add FreeBSD build instructions and current status (#33617)
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>
This commit is contained in:
parent
3041de0cdf
commit
351ba5023b
1 changed files with 29 additions and 8 deletions
|
@ -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.
|
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.
|
For a debug build of the editor:
|
||||||
This is actively being worked on.
|
|
||||||
|
|
||||||
More progress and discussion can be found in [Zed’s GitHub Discussions](https://github.com/zed-industries/zed/discussions/29550).
|
```sh
|
||||||
|
cargo run
|
||||||
|
```
|
||||||
|
|
||||||
_Environment:
|
And to run the tests:
|
||||||
FreeBSD 14.2-RELEASE
|
|
||||||
Architecture: amd64 (x86_64)_
|
```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`.
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue