Reorganize building zed doc
Co-Authored-By: Joseph T. Lyons <19867440+JosephTLyons@users.noreply.github.com>
This commit is contained in:
parent
b64ae4df9c
commit
d0f22df1eb
1 changed files with 52 additions and 48 deletions
|
@ -1,7 +1,7 @@
|
|||
# Building Zed
|
||||
|
||||
🚧 TODO:
|
||||
- [ ] Tidy up & update instructions
|
||||
|
||||
- [ ] Remove ZI-specific things
|
||||
- [ ] Rework any steps that currently require a ZI-specific account
|
||||
|
||||
|
@ -25,9 +25,9 @@ How to build Zed from source for the first time.
|
|||
|
||||
### Dependencies
|
||||
|
||||
* Install [Rust](https://www.rust-lang.org/tools/install)
|
||||
- Install [Rust](https://www.rust-lang.org/tools/install)
|
||||
|
||||
* Install the [GitHub CLI](https://cli.github.com/), [Livekit] & [Foreman]
|
||||
- Install the [GitHub CLI](https://cli.github.com/), [Livekit](https://formulae.brew.sh/formula/livekit) & [Foreman](https://formulae.brew.sh/formula/foreman)
|
||||
|
||||
```bash
|
||||
brew install gh
|
||||
|
@ -35,15 +35,15 @@ brew install livekit
|
|||
brew install foreman
|
||||
```
|
||||
|
||||
* Install [Xcode](https://apps.apple.com/us/app/xcode/id497799835?mt=12) from the macOS App Store
|
||||
- Install [Xcode](https://apps.apple.com/us/app/xcode/id497799835?mt=12) from the macOS App Store
|
||||
|
||||
* Install Xcode command line tools
|
||||
- Install [Xcode command line tools](https://developer.apple.com/xcode/resources/)
|
||||
|
||||
```bash
|
||||
xcode-select --install
|
||||
```
|
||||
|
||||
- If xcode-select --print-path prints /Library/Developer/CommandLineTools… run `sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer.`
|
||||
- If `xcode-select --print-path prints /Library/Developer/CommandLineTools…` run `sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer.`
|
||||
|
||||
* Install [Postgres](https://postgresapp.com)
|
||||
|
||||
|
@ -63,36 +63,27 @@ gh repo clone zed-industries/zed
|
|||
|
||||
1. (Optional but recommended) Add your GITHUB_TOKEN to your `.zshrc` or `.bashrc` like this: `export GITHUB_TOKEN=yourGithubAPIToken`
|
||||
1. (🚧 TODO 🚧 - Will this be relevant for open source?) Ensure the Zed.dev website is checked out in a sibling directory and install its dependencies:
|
||||
```
|
||||
cd ..
|
||||
git clone https://github.com/zed-industries/zed.dev
|
||||
cd zed.dev && npm install
|
||||
pnpm install -g vercel
|
||||
```
|
||||
|
||||
```bash
|
||||
cd ..
|
||||
git clone https://github.com/zed-industries/zed.dev
|
||||
cd zed.dev && npm install
|
||||
pnpm install -g vercel
|
||||
```
|
||||
|
||||
1. (🚧 TODO 🚧 - Will this be relevant for open source?) Link your zed.dev project to Vercel
|
||||
- `vercel link`
|
||||
- Select the `zed-industries` team. If you don't have this get someone on the team to add you to it.
|
||||
- Select the `zed.dev` project
|
||||
|
||||
- `vercel link`
|
||||
- Select the `zed-industries` team. If you don't have this get someone on the team to add you to it.
|
||||
- Select the `zed.dev` project
|
||||
|
||||
1. (🚧 TODO 🚧 - Will this be relevant for open source?) Run `vercel pull` to pull down the environment variables and project info from Vercel
|
||||
1. Open Postgres.app
|
||||
1. From `./path/to/zed/`:
|
||||
- Run:
|
||||
- `GITHUB_TOKEN={yourGithubAPIToken} script/bootstrap`
|
||||
- You don't need to include the GITHUB_TOKEN if you exported it above.
|
||||
- Consider removing the token (if it's fine for you to recreate such tokens during occasional migrations) or store this token somewhere safe (like your Zed 1Password vault).
|
||||
- If you get:
|
||||
- ```bash
|
||||
Error: Cannot install in Homebrew on ARM processor in Intel default prefix (/usr/local)!
|
||||
Please create a new installation in /opt/homebrew using one of the
|
||||
"Alternative Installs" from:
|
||||
https://docs.brew.sh/Installation
|
||||
```
|
||||
- In that case try:
|
||||
- `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
|
||||
- If Homebrew is not in your PATH:
|
||||
- Replace `{username}` with your home folder name (usually your login name)
|
||||
- `echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> /Users/{username}/.zprofile`
|
||||
- `eval "$(/opt/homebrew/bin/brew shellenv)"`
|
||||
1. From `./path/to/zed/` run `GITHUB_TOKEN={yourGithubAPIToken} script/bootstrap`
|
||||
|
||||
- You don't need to include the GITHUB_TOKEN if you exported it above.
|
||||
- Consider removing the token (if it's fine for you to recreate such tokens during occasional migrations) or store this token somewhere safe (like your Zed 1Password vault).
|
||||
|
||||
1. To run the Zed app:
|
||||
- If you are working on zed:
|
||||
- `cargo run`
|
||||
|
@ -109,8 +100,21 @@ gh repo clone zed-industries/zed
|
|||
|
||||
**`xcrun: error: unable to find utility "metal", not a developer tool or in PATH`**
|
||||
|
||||
### `script/bootstrap`
|
||||
|
||||
### Seeding errors during `script/bootstrap` runs
|
||||
```bash
|
||||
Error: Cannot install in Homebrew on ARM processor in Intel default prefix (/usr/local)!
|
||||
Please create a new installation in /opt/homebrew using one of the
|
||||
"Alternative Installs" from:
|
||||
https://docs.brew.sh/Installation
|
||||
```
|
||||
|
||||
- In that case try `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
|
||||
|
||||
- If Homebrew is not in your PATH:
|
||||
- Replace `{username}` with your home folder name (usually your login name)
|
||||
- `echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> /Users/{username}/.zprofile`
|
||||
- `eval "$(/opt/homebrew/bin/brew shellenv)"`
|
||||
|
||||
```
|
||||
seeding database...
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue