docs: Consolidate backend setup docs into local-collaboration.md (#34653)
Simplify docs for mac/linux/windows by consolidating the backend dependencies (collaboration) docs into local-collaboration.md. Most users building zed will not need to do this -- streamline them into getting setup to build the zed client app first. Release Notes: - N/A
This commit is contained in:
parent
fb88de9223
commit
5f92ac25a7
4 changed files with 73 additions and 46 deletions
|
@ -31,6 +31,10 @@ Clone down the [Zed repository](https://github.com/zed-industries/zed).
|
|||
brew install cmake
|
||||
```
|
||||
|
||||
### Backend Dependencies (optional) {#backend-dependencies}
|
||||
|
||||
If you are looking to develop Zed collaboration features using a local collabortation server, please see: [Local Collaboration](./local-collaboration.md) docs.
|
||||
|
||||
## Building Zed from Source
|
||||
|
||||
Once you have the dependencies installed, you can build Zed using [Cargo](https://doc.rust-lang.org/cargo/).
|
||||
|
@ -53,25 +57,6 @@ And to run the tests:
|
|||
cargo test --workspace
|
||||
```
|
||||
|
||||
## Backend Dependencies
|
||||
|
||||
If you are developing collaborative features of Zed, you'll need to install the dependencies of zed's `collab` server:
|
||||
|
||||
- Install [Postgres](https://postgresapp.com)
|
||||
- Install [Livekit](https://formulae.brew.sh/formula/livekit) and [Foreman](https://formulae.brew.sh/formula/foreman)
|
||||
|
||||
```sh
|
||||
brew install livekit foreman
|
||||
```
|
||||
|
||||
- Follow the steps in the [collab README](https://github.com/zed-industries/zed/blob/main/crates/collab/README.md) to configure the Postgres database for integration tests
|
||||
|
||||
Alternatively, if you have [Docker](https://www.docker.com/) installed you can bring up all the `collab` dependencies using Docker Compose:
|
||||
|
||||
```sh
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Error compiling metal shaders
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue