@@ -8,7 +8,31 @@ Welcome to Zed, a lightning-fast, collaborative code editor that makes your drea
### Dependencies
-* Install [Postgres.app](https://postgresapp.com) and start it.
+* Install Xcode from https://apps.apple.com/us/app/xcode/id497799835?mt=12, and accept the license:
+ ```
+ sudo xcodebuild -license
+ ```
+
+* Install homebrew, rust and node
+ ```
+ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+ brew install rust
+ brew install node
+ ```
+
+* Ensure rust executables are in your $PATH
+ ```
+ echo $HOME/.cargo/bin | sudo tee /etc/paths.d/10-rust
+ ```
+
+* Install postgres and configure the database
+ ```
+ brew install postgresql@15
+ brew services start postgresql@15
+ psql -c "CREATE ROLE postgres SUPERUSER LOGIN" postgres
+ psql -U postgres -c "CREATE DATABASE zed"
+ ```
+
* Install the `LiveKit` server and the `foreman` process supervisor:
```
@@ -41,6 +65,17 @@ Welcome to Zed, a lightning-fast, collaborative code editor that makes your drea
GITHUB_TOKEN=<$token> script/bootstrap
```
+* Now try running zed with collaboration disabled:
+ ```
+ cargo run
+ ```
+
+### Common errors
+
+* `xcrun: error: unable to find utility "metal", not a developer tool or in PATH`
+ * You need to install Xcode and then run: `xcode-select --switch /Applications/Xcode.app/Contents/Developer`
+ * (see https://github.com/gfx-rs/gfx/issues/2309)
+
### Testing against locally-running servers
Start the web and collab servers: